hybrid_identity_metadata
Creates, updates, deletes, gets or lists a hybrid_identity_metadata resource.
Overview
| Name | hybrid_identity_metadata |
| Type | Resource |
| Id | azure_stack.azure_stack_hci_vm.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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
identity | object | Identity for the resource. |
provisioningState | string | Provisioning state of the virtual machine instance. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled) |
publicKey | string | The Public Key. |
resourceUid | string | The unique identifier for the 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 | resource_uri | Implements HybridIdentityMetadata GET method. | |
list_by_virtual_machine_instance | exec | resource_uri | Returns the list of HybridIdentityMetadata of the given vm. |
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 |
|---|---|---|
resource_uri | string | The fully qualified Azure Resource manager identifier of the resource. Required. |
SELECT examples
- get
Implements HybridIdentityMetadata GET method.
SELECT
id,
name,
identity,
provisioningState,
publicKey,
resourceUid,
systemData,
type
FROM azure_stack.azure_stack_hci_vm.hybrid_identity_metadata
WHERE resource_uri = '{{ resource_uri }}' -- required
;
Lifecycle Methods
- list_by_virtual_machine_instance
Returns the list of HybridIdentityMetadata of the given vm.
EXEC azure_stack.azure_stack_hci_vm.hybrid_identity_metadata.list_by_virtual_machine_instance
@resource_uri='{{ resource_uri }}' --required
;