Vm Instance Hybrid Identity Metadata - Get

Service:: Azure Arc enabled VMware

API Version:: 2023-12-01

Gets HybridIdentityMetadata.
Implements HybridIdentityMetadata GET method.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default/hybridIdentityMetadata/default?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
resourceUri	path	True	string	The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	VmInstanceHybridIdentityMetadata	Success
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GetHybridIdentityMetadata

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default/hybridIdentityMetadata/default?api-version=2023-12-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ConnectedVMwarevSphere;

// Generated from example definition: specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/stable/2023-12-01/examples/GetVmInstanceHybridIdentityMetadata.json
// this example is just showing the usage of "VmInstanceHybridIdentityMetadata_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VmInstanceHybridIdentityMetadataResource created on azure
// for more information of creating VmInstanceHybridIdentityMetadataResource, please refer to the document of VmInstanceHybridIdentityMetadataResource
string resourceUri = "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM";
ResourceIdentifier vmInstanceHybridIdentityMetadataResourceId = VmInstanceHybridIdentityMetadataResource.CreateResourceIdentifier(resourceUri);
VmInstanceHybridIdentityMetadataResource vmInstanceHybridIdentityMetadata = client.GetVmInstanceHybridIdentityMetadataResource(vmInstanceHybridIdentityMetadataResourceId);

// invoke the operation
VmInstanceHybridIdentityMetadataResource result = await vmInstanceHybridIdentityMetadata.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VmInstanceHybridIdentityMetadataData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ConnectedVMwarevSphere/VitualMachineInstances/default/hybridIdentityMetadata/default",
  "name": "testItem",
  "type": "Microsoft.ConnectedVMwarevSphere/VitualMachineInstances/hybridIdentityMetadata",
  "properties": {
    "resourceUid": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c",
    "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	Gets the provisioning state.
systemData	Metadata pertaining to creation and last modification of the resource.
VmInstanceHybridIdentityMetadata	Defines the HybridIdentityMetadata.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

Enumeration

Gets the provisioning state.

Value	Description
Succeeded
Failed
Canceled
Provisioning
Updating
Deleting
Accepted
Created

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.