Vm Instance Hybrid Identity Metadatas - List By Virtual Machine Instance

Service:

Azure Arc enabled SCVMM

API Version:

2024-06-01

Implements GET HybridIdentityMetadata in a vm.
Returns the list of HybridIdentityMetadata of the given VM.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata?api-version=2024-06-01

URI Parameters

Name	In	Required	Type	Description
resourceUri	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VmInstanceHybridIdentityMetadataListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet

VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet

VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet

Sample request

HTTP

GET https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata?api-version=2024-06-01

Sample response

Status code:

200

{
  "value": [
    {
      "properties": {
        "resourceUid": "mikbntobifeiouinvsalnu",
        "publicKey": "hijhfxcdjuzidfjjztoh",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default",
      "name": "rxvpcegqc",
      "type": "ixqhymswessvylnqgti",
      "systemData": {
        "createdBy": "p",
        "createdByType": "User",
        "createdAt": "2024-01-29T22:28:00.094Z",
        "lastModifiedBy": "goxcwpyyqlxndquly",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2024-01-29T22:28:00.095Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet

Sample request

HTTP

GET https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata?api-version=2024-06-01

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default"
    }
  ]
}

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	The provisioning state of the resource.
systemData	Metadata pertaining to creation and last modification of the resource.
VmInstanceHybridIdentityMetadata	Defines the HybridIdentityMetadata.
VmInstanceHybridIdentityMetadataListResult	The response of a VmInstanceHybridIdentityMetadata list operation.

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

The provisioning state of the resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Provisioning	The resource is provisioning.
Updating	The resource is updating.
Deleting	The resource is being deleted.
Accepted	The resource has been accepted.
Created	The resource was 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.

VmInstanceHybridIdentityMetadata

Object

Defines the HybridIdentityMetadata.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
properties.publicKey	string	Gets or sets the Public Key.
properties.resourceUid	string	The unique identifier for the resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

VmInstanceHybridIdentityMetadataListResult

Object

The response of a VmInstanceHybridIdentityMetadata list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	VmInstanceHybridIdentityMetadata[]	The VmInstanceHybridIdentityMetadata items on this page