clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_stack.azure_stack_hci.clusters

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.
aadApplicationObjectId	string	Object id of cluster AAD identity.
aadClientId	string	App id of cluster AAD identity.
aadServicePrincipalObjectId	string	Id of cluster identity service principal.
aadTenantId	string	Tenant id of cluster AAD identity.
billingModel	string	Type of billing applied to the resource.
billingProperties	object	Billing properties of the cluster, including upcoming billing model details.
cloudId	string	Unique, immutable resource id.
cloudManagementEndpoint	string	Endpoint configured for management from the Azure portal.
clusterPattern	string	Supported Storage Type for HCI Cluster. Known values are: "Standard" and "RackAware". (Standard, RackAware)
confidentialVmProperties	object	Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource.
connectivityStatus	string	Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. Known values are: "NotYetRegistered", "Connected", "NotConnectedRecently", "PartiallyConnected", "Disconnected", and "NotSpecified". (NotYetRegistered, Connected, NotConnectedRecently, PartiallyConnected, Disconnected, NotSpecified)
desiredProperties	object	Desired properties of the cluster.
identity	object	The managed service identities assigned to this resource.
identityProvider	string	Identity Provider for the cluster. Known values are: "ActiveDirectory" and "LocalIdentity". (ActiveDirectory, LocalIdentity)
isManagementCluster	boolean	Is Management Cluster, when true indicates that the cluster is used for managing other clusters.
isolatedVmAttestationConfiguration	object	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
kind	string	This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal.
lastBillingTimestamp	string (date-time)	Most recent billing meter timestamp.
lastSyncTimestamp	string (date-time)	Most recent cluster sync timestamp.
localAvailabilityZones	array	Local Availability Zone information for HCI cluster.
location	string	The geo-location where the resource lives. Required.
logCollectionProperties	object	Log Collection properties of the cluster.
provisioningState	string	Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
registrationTimestamp	string (date-time)	First cluster sync timestamp.
remoteSupportProperties	object	RemoteSupport properties of the cluster.
reportedProperties	object	Properties reported by cluster agent.
resourceProviderObjectId	string	Object id of RP Service Principal.
ring	string	The ring to which this cluster belongs to.
sdnProperties	object	Software Defined Networking Properties of the cluster.
secretsLocations	array	List of secret locations.
serviceEndpoint	string	Region specific DataPath Endpoint of the cluster.
softwareAssuranceProperties	object	Software Assurance properties of the cluster.
status	string	Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. Known values are: "NotYetRegistered", "ConnectedRecently", "NotConnectedRecently", "Disconnected", "Error", "NotSpecified", "ValidationInProgress", "ValidationSuccess", "ValidationFailed", "DeploymentInProgress", "DeploymentFailed", and "DeploymentSuccess". (NotYetRegistered, ConnectedRecently, NotConnectedRecently, Disconnected, Error, NotSpecified, ValidationInProgress, ValidationSuccess, ValidationFailed, DeploymentInProgress, DeploymentFailed, DeploymentSuccess)
storageType	string	Storage type of the cluster. Indicates whether the cluster uses S2D, SAN, or a combination. Known values are: "S2D", "SAN", and "SANS2D". (S2D, SAN, SANS2D)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
trialDaysRemaining	number	Number of days remaining in the trial period.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
aadApplicationObjectId	string	Object id of cluster AAD identity.
aadClientId	string	App id of cluster AAD identity.
aadServicePrincipalObjectId	string	Id of cluster identity service principal.
aadTenantId	string	Tenant id of cluster AAD identity.
billingModel	string	Type of billing applied to the resource.
billingProperties	object	Billing properties of the cluster, including upcoming billing model details.
cloudId	string	Unique, immutable resource id.
cloudManagementEndpoint	string	Endpoint configured for management from the Azure portal.
clusterPattern	string	Supported Storage Type for HCI Cluster. Known values are: "Standard" and "RackAware". (Standard, RackAware)
confidentialVmProperties	object	Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource.
connectivityStatus	string	Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. Known values are: "NotYetRegistered", "Connected", "NotConnectedRecently", "PartiallyConnected", "Disconnected", and "NotSpecified". (NotYetRegistered, Connected, NotConnectedRecently, PartiallyConnected, Disconnected, NotSpecified)
desiredProperties	object	Desired properties of the cluster.
identity	object	The managed service identities assigned to this resource.
identityProvider	string	Identity Provider for the cluster. Known values are: "ActiveDirectory" and "LocalIdentity". (ActiveDirectory, LocalIdentity)
isManagementCluster	boolean	Is Management Cluster, when true indicates that the cluster is used for managing other clusters.
isolatedVmAttestationConfiguration	object	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
kind	string	This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal.
lastBillingTimestamp	string (date-time)	Most recent billing meter timestamp.
lastSyncTimestamp	string (date-time)	Most recent cluster sync timestamp.
localAvailabilityZones	array	Local Availability Zone information for HCI cluster.
location	string	The geo-location where the resource lives. Required.
logCollectionProperties	object	Log Collection properties of the cluster.
provisioningState	string	Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
registrationTimestamp	string (date-time)	First cluster sync timestamp.
remoteSupportProperties	object	RemoteSupport properties of the cluster.
reportedProperties	object	Properties reported by cluster agent.
resourceProviderObjectId	string	Object id of RP Service Principal.
ring	string	The ring to which this cluster belongs to.
sdnProperties	object	Software Defined Networking Properties of the cluster.
secretsLocations	array	List of secret locations.
serviceEndpoint	string	Region specific DataPath Endpoint of the cluster.
softwareAssuranceProperties	object	Software Assurance properties of the cluster.
status	string	Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. Known values are: "NotYetRegistered", "ConnectedRecently", "NotConnectedRecently", "Disconnected", "Error", "NotSpecified", "ValidationInProgress", "ValidationSuccess", "ValidationFailed", "DeploymentInProgress", "DeploymentFailed", and "DeploymentSuccess". (NotYetRegistered, ConnectedRecently, NotConnectedRecently, Disconnected, Error, NotSpecified, ValidationInProgress, ValidationSuccess, ValidationFailed, DeploymentInProgress, DeploymentFailed, DeploymentSuccess)
storageType	string	Storage type of the cluster. Indicates whether the cluster uses S2D, SAN, or a combination. Known values are: "S2D", "SAN", and "SANS2D". (S2D, SAN, SANS2D)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
trialDaysRemaining	number	Number of days remaining in the trial period.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
aadApplicationObjectId	string	Object id of cluster AAD identity.
aadClientId	string	App id of cluster AAD identity.
aadServicePrincipalObjectId	string	Id of cluster identity service principal.
aadTenantId	string	Tenant id of cluster AAD identity.
billingModel	string	Type of billing applied to the resource.
billingProperties	object	Billing properties of the cluster, including upcoming billing model details.
cloudId	string	Unique, immutable resource id.
cloudManagementEndpoint	string	Endpoint configured for management from the Azure portal.
clusterPattern	string	Supported Storage Type for HCI Cluster. Known values are: "Standard" and "RackAware". (Standard, RackAware)
confidentialVmProperties	object	Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource.
connectivityStatus	string	Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. Known values are: "NotYetRegistered", "Connected", "NotConnectedRecently", "PartiallyConnected", "Disconnected", and "NotSpecified". (NotYetRegistered, Connected, NotConnectedRecently, PartiallyConnected, Disconnected, NotSpecified)
desiredProperties	object	Desired properties of the cluster.
identity	object	The managed service identities assigned to this resource.
identityProvider	string	Identity Provider for the cluster. Known values are: "ActiveDirectory" and "LocalIdentity". (ActiveDirectory, LocalIdentity)
isManagementCluster	boolean	Is Management Cluster, when true indicates that the cluster is used for managing other clusters.
isolatedVmAttestationConfiguration	object	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
kind	string	This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal.
lastBillingTimestamp	string (date-time)	Most recent billing meter timestamp.
lastSyncTimestamp	string (date-time)	Most recent cluster sync timestamp.
localAvailabilityZones	array	Local Availability Zone information for HCI cluster.
location	string	The geo-location where the resource lives. Required.
logCollectionProperties	object	Log Collection properties of the cluster.
provisioningState	string	Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
registrationTimestamp	string (date-time)	First cluster sync timestamp.
remoteSupportProperties	object	RemoteSupport properties of the cluster.
reportedProperties	object	Properties reported by cluster agent.
resourceProviderObjectId	string	Object id of RP Service Principal.
ring	string	The ring to which this cluster belongs to.
sdnProperties	object	Software Defined Networking Properties of the cluster.
secretsLocations	array	List of secret locations.
serviceEndpoint	string	Region specific DataPath Endpoint of the cluster.
softwareAssuranceProperties	object	Software Assurance properties of the cluster.
status	string	Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. Known values are: "NotYetRegistered", "ConnectedRecently", "NotConnectedRecently", "Disconnected", "Error", "NotSpecified", "ValidationInProgress", "ValidationSuccess", "ValidationFailed", "DeploymentInProgress", "DeploymentFailed", and "DeploymentSuccess". (NotYetRegistered, ConnectedRecently, NotConnectedRecently, Disconnected, Error, NotSpecified, ValidationInProgress, ValidationSuccess, ValidationFailed, DeploymentInProgress, DeploymentFailed, DeploymentSuccess)
storageType	string	Storage type of the cluster. Indicates whether the cluster uses S2D, SAN, or a combination. Known values are: "S2D", "SAN", and "SANS2D". (S2D, SAN, SANS2D)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
trialDaysRemaining	number	Number of days remaining in the trial period.
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_group_name, cluster_name, subscription_id		Get HCI cluster.
list_by_resource_group	select	resource_group_name, subscription_id		List all HCI clusters in a resource group.
list_by_subscription	select	subscription_id		List all HCI clusters in a subscription.
create	insert	resource_group_name, cluster_name, subscription_id, location		Create an HCI cluster.
update	update	resource_group_name, cluster_name, subscription_id		Update an HCI cluster.
delete	delete	resource_group_name, cluster_name, subscription_id		Delete an HCI cluster.
update_secrets_locations	exec	resource_group_name, cluster_name, subscription_id		Update cluster secrets locations.
upload_certificate	exec	resource_group_name, cluster_name, subscription_id		Upload certificate.
create_identity	exec	resource_group_name, cluster_name, subscription_id		Create cluster identity.
extend_software_assurance_benefit	exec	resource_group_name, cluster_name, subscription_id		Extends Software Assurance Benefit to a cluster.
change_ring	exec	resource_group_name, cluster_name, subscription_id		Changes ring of a cluster.
trigger_log_collection	exec	resource_group_name, cluster_name, subscription_id		Trigger Log Collection on a cluster.
configure_remote_support	exec	resource_group_name, cluster_name, subscription_id		Configure RemoteSupport on a cluster.

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
cluster_name	string	The name of the cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get HCI cluster.

SELECT
id,
name,
aadApplicationObjectId,
aadClientId,
aadServicePrincipalObjectId,
aadTenantId,
billingModel,
billingProperties,
cloudId,
cloudManagementEndpoint,
clusterPattern,
confidentialVmProperties,
connectivityStatus,
desiredProperties,
identity,
identityProvider,
isManagementCluster,
isolatedVmAttestationConfiguration,
kind,
lastBillingTimestamp,
lastSyncTimestamp,
localAvailabilityZones,
location,
logCollectionProperties,
provisioningState,
registrationTimestamp,
remoteSupportProperties,
reportedProperties,
resourceProviderObjectId,
ring,
sdnProperties,
secretsLocations,
serviceEndpoint,
softwareAssuranceProperties,
status,
storageType,
systemData,
tags,
trialDaysRemaining,
type
FROM azure_stack.azure_stack_hci.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all HCI clusters in a resource group.

SELECT
id,
name,
aadApplicationObjectId,
aadClientId,
aadServicePrincipalObjectId,
aadTenantId,
billingModel,
billingProperties,
cloudId,
cloudManagementEndpoint,
clusterPattern,
confidentialVmProperties,
connectivityStatus,
desiredProperties,
identity,
identityProvider,
isManagementCluster,
isolatedVmAttestationConfiguration,
kind,
lastBillingTimestamp,
lastSyncTimestamp,
localAvailabilityZones,
location,
logCollectionProperties,
provisioningState,
registrationTimestamp,
remoteSupportProperties,
reportedProperties,
resourceProviderObjectId,
ring,
sdnProperties,
secretsLocations,
serviceEndpoint,
softwareAssuranceProperties,
status,
storageType,
systemData,
tags,
trialDaysRemaining,
type
FROM azure_stack.azure_stack_hci.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all HCI clusters in a subscription.

SELECT
id,
name,
aadApplicationObjectId,
aadClientId,
aadServicePrincipalObjectId,
aadTenantId,
billingModel,
billingProperties,
cloudId,
cloudManagementEndpoint,
clusterPattern,
confidentialVmProperties,
connectivityStatus,
desiredProperties,
identity,
identityProvider,
isManagementCluster,
isolatedVmAttestationConfiguration,
kind,
lastBillingTimestamp,
lastSyncTimestamp,
localAvailabilityZones,
location,
logCollectionProperties,
provisioningState,
registrationTimestamp,
remoteSupportProperties,
reportedProperties,
resourceProviderObjectId,
ring,
sdnProperties,
secretsLocations,
serviceEndpoint,
softwareAssuranceProperties,
status,
storageType,
systemData,
tags,
trialDaysRemaining,
type
FROM azure_stack.azure_stack_hci.clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create an HCI cluster.

INSERT INTO azure_stack.azure_stack_hci.clusters (
tags,
location,
properties,
identity,
kind,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the clusters resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Cluster properties.
    value:
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      connectivityStatus: "{{ connectivityStatus }}"
      cloudId: "{{ cloudId }}"
      ring: "{{ ring }}"
      cloudManagementEndpoint: "{{ cloudManagementEndpoint }}"
      aadClientId: "{{ aadClientId }}"
      aadTenantId: "{{ aadTenantId }}"
      aadApplicationObjectId: "{{ aadApplicationObjectId }}"
      aadServicePrincipalObjectId: "{{ aadServicePrincipalObjectId }}"
      softwareAssuranceProperties:
        softwareAssuranceStatus: "{{ softwareAssuranceStatus }}"
        softwareAssuranceIntent: "{{ softwareAssuranceIntent }}"
        lastUpdated: "{{ lastUpdated }}"
      isManagementCluster: {{ isManagementCluster }}
      logCollectionProperties:
        fromDate: "{{ fromDate }}"
        toDate: "{{ toDate }}"
        lastLogGenerated: "{{ lastLogGenerated }}"
        logCollectionSessionDetails:
          - logStartTime: "{{ logStartTime }}"
            logEndTime: "{{ logEndTime }}"
            timeCollected: "{{ timeCollected }}"
            logSize: {{ logSize }}
            logCollectionStatus: "{{ logCollectionStatus }}"
            correlationId: "{{ correlationId }}"
            logCollectionJobType: "{{ logCollectionJobType }}"
            endTimeCollected: "{{ endTimeCollected }}"
            logCollectionError:
              errorCode: "{{ errorCode }}"
              errorMessage: "{{ errorMessage }}"
      remoteSupportProperties:
        accessLevel: "{{ accessLevel }}"
        expirationTimeStamp: "{{ expirationTimeStamp }}"
        remoteSupportType: "{{ remoteSupportType }}"
        remoteSupportNodeSettings:
          - arcResourceId: "{{ arcResourceId }}"
            state: "{{ state }}"
            createdAt: "{{ createdAt }}"
            updatedAt: "{{ updatedAt }}"
            connectionStatus: "{{ connectionStatus }}"
            connectionErrorMessage: "{{ connectionErrorMessage }}"
            transcriptLocation: "{{ transcriptLocation }}"
        remoteSupportSessionDetails:
          - sessionStartTime: "{{ sessionStartTime }}"
            sessionEndTime: "{{ sessionEndTime }}"
            nodeName: "{{ nodeName }}"
            duration: {{ duration }}
            accessLevel: "{{ accessLevel }}"
            transcriptLocation: "{{ transcriptLocation }}"
        remoteSupportProvisioningState: "{{ remoteSupportProvisioningState }}"
      desiredProperties:
        windowsServerSubscription: "{{ windowsServerSubscription }}"
        diagnosticLevel: "{{ diagnosticLevel }}"
      reportedProperties:
        clusterName: "{{ clusterName }}"
        clusterId: "{{ clusterId }}"
        clusterVersion: "{{ clusterVersion }}"
        nodes:
          - name: "{{ name }}"
            id: {{ id }}
            windowsServerSubscription: "{{ windowsServerSubscription }}"
            nodeType: "{{ nodeType }}"
            ehcResourceId: "{{ ehcResourceId }}"
            manufacturer: "{{ manufacturer }}"
            model: "{{ model }}"
            osName: "{{ osName }}"
            osVersion: "{{ osVersion }}"
            osDisplayVersion: "{{ osDisplayVersion }}"
            serialNumber: "{{ serialNumber }}"
            coreCount: {{ coreCount }}
            memoryInGiB: {{ memoryInGiB }}
            lastLicensingTimestamp: "{{ lastLicensingTimestamp }}"
            oemActivation: "{{ oemActivation }}"
        lastUpdated: "{{ lastUpdated }}"
        msiExpirationTimeStamp: "{{ msiExpirationTimeStamp }}"
        imdsAttestation: "{{ imdsAttestation }}"
        diagnosticLevel: "{{ diagnosticLevel }}"
        supportedCapabilities:
          - "{{ supportedCapabilities }}"
        clusterType: "{{ clusterType }}"
        manufacturer: "{{ manufacturer }}"
        oemActivation: "{{ oemActivation }}"
        hardwareClass: "{{ hardwareClass }}"
      isolatedVmAttestationConfiguration:
        attestationResourceId: "{{ attestationResourceId }}"
        relyingPartyServiceEndpoint: "{{ relyingPartyServiceEndpoint }}"
        attestationServiceEndpoint: "{{ attestationServiceEndpoint }}"
      trialDaysRemaining: {{ trialDaysRemaining }}
      billingModel: "{{ billingModel }}"
      billingProperties:
        nextBillingModel:
          billingModel: "{{ billingModel }}"
          capabilitiesEnabled:
            - "{{ capabilitiesEnabled }}"
          trialDaysRemaining: {{ trialDaysRemaining }}
      registrationTimestamp: "{{ registrationTimestamp }}"
      lastSyncTimestamp: "{{ lastSyncTimestamp }}"
      lastBillingTimestamp: "{{ lastBillingTimestamp }}"
      serviceEndpoint: "{{ serviceEndpoint }}"
      resourceProviderObjectId: "{{ resourceProviderObjectId }}"
      secretsLocations:
        - secretsType: "{{ secretsType }}"
          secretsLocation: "{{ secretsLocation }}"
      clusterPattern: "{{ clusterPattern }}"
      confidentialVmProperties:
        confidentialVmIntent: "{{ confidentialVmIntent }}"
        confidentialVmStatus: "{{ confidentialVmStatus }}"
        confidentialVmStatusSummary: "{{ confidentialVmStatusSummary }}"
      sdnProperties:
        sdnStatus: "{{ sdnStatus }}"
        sdnDomainName: "{{ sdnDomainName }}"
        sdnApiAddress: "{{ sdnApiAddress }}"
        sdnIntegrationIntent: "{{ sdnIntegrationIntent }}"
      localAvailabilityZones:
        - localAvailabilityZoneName: "{{ localAvailabilityZoneName }}"
          nodes: "{{ nodes }}"
      identityProvider: "{{ identityProvider }}"
      storageType: "{{ storageType }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal.

UPDATE examples

update

Update an HCI cluster.

UPDATE azure_stack.azure_stack_hci.clusters
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an HCI cluster.

DELETE FROM azure_stack.azure_stack_hci.clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_secrets_locations

Update cluster secrets locations.

EXEC azure_stack.azure_stack_hci.clusters.update_secrets_locations 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

upload_certificate

Upload certificate.

EXEC azure_stack.azure_stack_hci.clusters.upload_certificate 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

create_identity

Create cluster identity.

EXEC azure_stack.azure_stack_hci.clusters.create_identity 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

extend_software_assurance_benefit

Extends Software Assurance Benefit to a cluster.

EXEC azure_stack.azure_stack_hci.clusters.extend_software_assurance_benefit 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

change_ring

Changes ring of a cluster.

EXEC azure_stack.azure_stack_hci.clusters.change_ring 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

trigger_log_collection

Trigger Log Collection on a cluster.

EXEC azure_stack.azure_stack_hci.clusters.trigger_log_collection 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

configure_remote_support

Configure RemoteSupport on a cluster.

EXEC azure_stack.azure_stack_hci.clusters.configure_remote_support 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;