hybrid_identity_metadata

Creates, updates, deletes, gets or lists a hybrid_identity_metadata resource.

Overview

Name	hybrid_identity_metadata
Type	Resource
Id	azure.hybrid_container_service.hybrid_identity_metadata

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Deleting", "Updating", "Upgrading", and "Accepted".
publicKey	string	Onboarding public key for provisioning the Managed identity for the connected cluster.
resourceUid	string	Unique id of the parent provisioned cluster resource.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connected_cluster_resource_uri		Get the hybrid identity metadata resource. Get the hybrid identity metadata proxy resource.
delete	delete	connected_cluster_resource_uri		Deletes the hybrid identity metadata resource. Deletes the hybrid identity metadata proxy resource.
put	exec	connected_cluster_resource_uri, properties		Creates the hybrid identity metadata resource. Creates the hybrid identity metadata proxy resource that facilitates the managed identity provisioning.
list_by_cluster	exec	connected_cluster_resource_uri		Lists the hybrid identity metadata resources in a provisioned cluster instance. Lists the hybrid identity metadata proxy resource in a provisioned cluster instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connected_cluster_resource_uri	string	The fully qualified Azure Resource Manager identifier of the connected cluster resource. Required.

SELECT examples

get

Get the hybrid identity metadata resource. Get the hybrid identity metadata proxy resource.

SELECT
id,
name,
provisioningState,
publicKey,
resourceUid,
systemData,
type
FROM azure.hybrid_container_service.hybrid_identity_metadata
WHERE connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' -- required
;

DELETE examples

delete

Deletes the hybrid identity metadata resource. Deletes the hybrid identity metadata proxy resource.

DELETE FROM azure.hybrid_container_service.hybrid_identity_metadata
WHERE connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' --required
;

Lifecycle Methods

put

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

EXEC azure.hybrid_container_service.hybrid_identity_metadata.put 
@connected_cluster_resource_uri='{{ connected_cluster_resource_uri }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

list_by_cluster

Lists the hybrid identity metadata resources in a provisioned cluster instance. Lists the hybrid identity metadata proxy resource in a provisioned cluster instance.

EXEC azure.hybrid_container_service.hybrid_identity_metadata.list_by_cluster 
@connected_cluster_resource_uri='{{ connected_cluster_resource_uri }}' --required
;