clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_stack.azure_stack_hci.clusters

Fields

vw_clusters

Name	Datatype	Description
aad_application_object_id	text	field from the properties object
aad_client_id	text	field from the properties object
aad_service_principal_object_id	text	field from the properties object
aad_tenant_id	text	field from the properties object
billing_model	text	field from the properties object
cloud_id	text	field from the properties object
cloud_management_endpoint	text	field from the properties object
clusterName	text	field from the properties object
connectivity_status	text	field from the properties object
desired_properties	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
isolated_vm_attestation_configuration	text	field from the properties object
last_billing_timestamp	text	field from the properties object
last_sync_timestamp	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
registration_timestamp	text	field from the properties object
reported_properties	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_provider_object_id	text	field from the properties object
service_endpoint	text	field from the properties object
software_assurance_properties	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
trial_days_remaining	text	field from the properties object

clusters

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	Cluster properties.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Get HCI cluster.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List all HCI clusters in a resource group.
list_by_subscription	SELECT	subscriptionId	List all HCI clusters in a subscription.
create	INSERT	clusterName, resourceGroupName, subscriptionId	Create an HCI cluster.
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Delete an HCI cluster.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Update an HCI cluster.
extend_software_assurance_benefit	EXEC	clusterName, resourceGroupName, subscriptionId	Extends Software Assurance Benefit to a cluster
upload_certificate	EXEC	clusterName, resourceGroupName, subscriptionId	Upload certificate.

SELECT examples

List all HCI clusters in a subscription.

vw_clusters

SELECT
aad_application_object_id,
aad_client_id,
aad_service_principal_object_id,
aad_tenant_id,
billing_model,
cloud_id,
cloud_management_endpoint,
clusterName,
connectivity_status,
desired_properties,
identity,
isolated_vm_attestation_configuration,
last_billing_timestamp,
last_sync_timestamp,
location,
provisioning_state,
registration_timestamp,
reported_properties,
resourceGroupName,
resource_provider_object_id,
service_endpoint,
software_assurance_properties,
status,
subscriptionId,
tags,
trial_days_remaining
FROM azure_stack.azure_stack_hci.vw_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

clusters

SELECT
identity,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.clusters
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new clusters resource.

All Properties

/*+ create */
INSERT INTO azure_stack.azure_stack_hci.clusters (
clusterName,
resourceGroupName,
subscriptionId,
tags,
location,
identity,
properties
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: status
          value: string
        - name: connectivityStatus
          value: string
        - name: cloudId
          value: string
        - name: cloudManagementEndpoint
          value: string
        - name: aadClientId
          value: string
        - name: aadTenantId
          value: string
        - name: aadApplicationObjectId
          value: string
        - name: aadServicePrincipalObjectId
          value: string
        - name: softwareAssuranceProperties
          value:
            - name: softwareAssuranceStatus
              value: string
            - name: softwareAssuranceIntent
              value: string
            - name: lastUpdated
              value: string
        - name: desiredProperties
          value:
            - name: windowsServerSubscription
              value: string
            - name: diagnosticLevel
              value: string
        - name: reportedProperties
          value:
            - name: clusterName
              value: string
            - name: clusterId
              value: string
            - name: clusterVersion
              value: string
            - name: nodes
              value:
                - - name: name
                    value: string
                  - name: id
                    value: number
                  - name: windowsServerSubscription
                    value: string
                  - name: nodeType
                    value: string
                  - name: ehcResourceId
                    value: string
                  - name: manufacturer
                    value: string
                  - name: model
                    value: string
                  - name: osName
                    value: string
                  - name: osVersion
                    value: string
                  - name: osDisplayVersion
                    value: string
                  - name: serialNumber
                    value: string
                  - name: coreCount
                    value: number
                  - name: memoryInGiB
                    value: number
                  - name: lastLicensingTimestamp
                    value: string
                  - name: oemActivation
                    value: string
            - name: lastUpdated
              value: string
            - name: imdsAttestation
              value: string
            - name: diagnosticLevel
              value: string
            - name: supportedCapabilities
              value:
                - string
            - name: clusterType
              value: string
            - name: manufacturer
              value: string
            - name: oemActivation
              value: string
        - name: isolatedVmAttestationConfiguration
          value:
            - name: attestationResourceId
              value: string
            - name: relyingPartyServiceEndpoint
              value: string
            - name: attestationServiceEndpoint
              value: string
        - name: trialDaysRemaining
          value: number
        - name: billingModel
          value: string
        - name: registrationTimestamp
          value: string
        - name: lastSyncTimestamp
          value: string
        - name: lastBillingTimestamp
          value: string
        - name: serviceEndpoint
          value: string
        - name: resourceProviderObjectId
          value: string

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE azure_stack.azure_stack_hci.clusters
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified clusters resource.

/*+ delete */
DELETE FROM azure_stack.azure_stack_hci.clusters
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';