Share via


Hybrid Identity Metadata - Put

Creates the hybrid identity metadata resource
Creates the hybrid identity metadata proxy resource that facilitates the managed identity provisioning.

PUT https://management.azure.com/{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata/default?api-version=2024-01-01

URI Parameters

Name In Required Type Description
connectedClusterResourceUri
path True

string

The fully qualified Azure Resource Manager identifier of the connected cluster resource.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
properties.publicKey

string

Onboarding public key for provisioning the Managed identity for the connected cluster.

properties.resourceUid

string

Unique id of the parent provisioned cluster resource.

Responses

Name Type Description
200 OK

hybridIdentityMetadata

Updates the hybridIdentityMetadata resource.

201 Created

hybridIdentityMetadata

Creates the hybridIdentityMetadata resource.

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

CreateHybridIdentityMetadata

Sample request

PUT https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata/default?api-version=2024-01-01

{
  "properties": {
    "resourceUid": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c",
    "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2"
  }
}

Sample response

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata/default",
  "name": "default",
  "type": "Microsoft.HybridContainerService/provisionedClusterInstances/hybridIdentityMetadata",
  "properties": {
    "resourceUid": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c",
    "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2"
  }
}
{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata/default",
  "name": "default",
  "type": "Microsoft.HybridContainerService/provisionedClusterInstances/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

hybridIdentityMetadata

Defines the hybridIdentityMetadata.

ResourceProvisioningState

Provisioning state of the resource

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

hybridIdentityMetadata

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

ResourceProvisioningState

Provisioning state of the resource

properties.publicKey

string

Onboarding public key for provisioning the Managed identity for the connected cluster.

properties.resourceUid

string

Unique id of the parent provisioned cluster resource.

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ResourceProvisioningState

Provisioning state of the resource

Value Description
Succeeded
Failed
Canceled
Pending
Creating
Deleting
Updating
Upgrading
Accepted

systemData

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.