clusters

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

Overview

Name	clusters
Type	Resource
Id	azure_extras.network_cloud.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.
actionStates	array	The current state of any in progress or completed actions. The most recent known instance of each action type is shown.
aggregatorOrSingleRackDefinition	object	RackDefinition represents details regarding the rack.
analyticsOutputSettings	object	The settings for the log analytics workspace used for output of logs from this cluster.
analyticsWorkspaceId	string	Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
availableUpgradeVersions	array	The list of cluster runtime version upgrades available for this cluster.
clusterCapacity	object	The capacity supported by this cluster.
clusterConnectionStatus	string	The latest heartbeat status between the cluster manager and the cluster. Known values are: "Connected", "Disconnected", "Timeout", and "Undefined". (Connected, Disconnected, Timeout, Undefined)
clusterExtendedLocation	object	The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.
clusterLocation	string	The customer-provided location information to identify where the cluster resides.
clusterManagerConnectionStatus	string	The latest connectivity status between cluster manager and the cluster. Known values are: "Connected" and "Unreachable". (Connected, Unreachable)
clusterManagerId	string	The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.
clusterServicePrincipal	object	Field Deprecated: Use managed identity to provide cluster privileges. The service principal to be used by the cluster during Arc Appliance installation.
clusterType	string	The type of rack configuration for the cluster. Required. Known values are: "SingleRack" and "MultiRack". (SingleRack, MultiRack)
clusterVersion	string	The current runtime version of the cluster. Required.
commandOutputSettings	object	The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
computeDeploymentThreshold	object	The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
computeRackDefinitions	array	The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.
detailedStatus	string	The current detailed status of the cluster. Known values are: "PendingDeployment", "Deploying", "Running", "Updating", "UpdatePaused", "Degraded", "Deleting", "Disconnected", and "Failed". (PendingDeployment, Deploying, Running, Updating, UpdatePaused, Degraded, Deleting, Disconnected, Failed)
detailedStatusMessage	string	The descriptive message about the detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
hybridAksExtendedLocation	object	Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).
identity	object	The managed service identities assigned to this resource.
kind	string	The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager. Known values are: "Nexus" and "AzureLocal". (Nexus, AzureLocal)
lastSuccessfulVersionUpdateTime	string (date-time)	The date and time of the end of the last successful version update for the cluster.
location	string	The geo-location where the resource lives. Required.
managedCredentials	array	The list of credentials that are managed for the cluster and can be rotated on-demand.
managedResourceGroupConfiguration	object	The configuration of the managed resource group associated with the resource.
manualActionCount	integer	The count of Manual Action Taken (MAT) events that have not been validated.
networkFabricId	string	The resource ID of the Network Fabric associated with the cluster. Required.
provisioningState	string	The provisioning state of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Validating", and "Updating". (Succeeded, Failed, Canceled, Accepted, Validating, Updating)
runtimeProtectionConfiguration	object	The settings for cluster runtime protection.
secretArchive	object	The configuration for use of a key vault to store secrets for later retrieval by the operator.
secretArchiveSettings	object	The settings for the secret archive used to hold credentials for the cluster.
supportExpiryDate	string	The support end date of the runtime version of the cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStrategy	object	The strategy for updating the cluster.
vulnerabilityScanningSettings	object	The settings for how security vulnerability scanning is applied to the cluster.
workloadResourceIds	array	The list of workload resource IDs that are hosted within this cluster.

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.
actionStates	array	The current state of any in progress or completed actions. The most recent known instance of each action type is shown.
aggregatorOrSingleRackDefinition	object	RackDefinition represents details regarding the rack.
analyticsOutputSettings	object	The settings for the log analytics workspace used for output of logs from this cluster.
analyticsWorkspaceId	string	Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
availableUpgradeVersions	array	The list of cluster runtime version upgrades available for this cluster.
clusterCapacity	object	The capacity supported by this cluster.
clusterConnectionStatus	string	The latest heartbeat status between the cluster manager and the cluster. Known values are: "Connected", "Disconnected", "Timeout", and "Undefined". (Connected, Disconnected, Timeout, Undefined)
clusterExtendedLocation	object	The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.
clusterLocation	string	The customer-provided location information to identify where the cluster resides.
clusterManagerConnectionStatus	string	The latest connectivity status between cluster manager and the cluster. Known values are: "Connected" and "Unreachable". (Connected, Unreachable)
clusterManagerId	string	The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.
clusterServicePrincipal	object	Field Deprecated: Use managed identity to provide cluster privileges. The service principal to be used by the cluster during Arc Appliance installation.
clusterType	string	The type of rack configuration for the cluster. Required. Known values are: "SingleRack" and "MultiRack". (SingleRack, MultiRack)
clusterVersion	string	The current runtime version of the cluster. Required.
commandOutputSettings	object	The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
computeDeploymentThreshold	object	The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
computeRackDefinitions	array	The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.
detailedStatus	string	The current detailed status of the cluster. Known values are: "PendingDeployment", "Deploying", "Running", "Updating", "UpdatePaused", "Degraded", "Deleting", "Disconnected", and "Failed". (PendingDeployment, Deploying, Running, Updating, UpdatePaused, Degraded, Deleting, Disconnected, Failed)
detailedStatusMessage	string	The descriptive message about the detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
hybridAksExtendedLocation	object	Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).
identity	object	The managed service identities assigned to this resource.
kind	string	The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager. Known values are: "Nexus" and "AzureLocal". (Nexus, AzureLocal)
lastSuccessfulVersionUpdateTime	string (date-time)	The date and time of the end of the last successful version update for the cluster.
location	string	The geo-location where the resource lives. Required.
managedCredentials	array	The list of credentials that are managed for the cluster and can be rotated on-demand.
managedResourceGroupConfiguration	object	The configuration of the managed resource group associated with the resource.
manualActionCount	integer	The count of Manual Action Taken (MAT) events that have not been validated.
networkFabricId	string	The resource ID of the Network Fabric associated with the cluster. Required.
provisioningState	string	The provisioning state of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Validating", and "Updating". (Succeeded, Failed, Canceled, Accepted, Validating, Updating)
runtimeProtectionConfiguration	object	The settings for cluster runtime protection.
secretArchive	object	The configuration for use of a key vault to store secrets for later retrieval by the operator.
secretArchiveSettings	object	The settings for the secret archive used to hold credentials for the cluster.
supportExpiryDate	string	The support end date of the runtime version of the cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStrategy	object	The strategy for updating the cluster.
vulnerabilityScanningSettings	object	The settings for how security vulnerability scanning is applied to the cluster.
workloadResourceIds	array	The list of workload resource IDs that are hosted within this cluster.

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.
actionStates	array	The current state of any in progress or completed actions. The most recent known instance of each action type is shown.
aggregatorOrSingleRackDefinition	object	RackDefinition represents details regarding the rack.
analyticsOutputSettings	object	The settings for the log analytics workspace used for output of logs from this cluster.
analyticsWorkspaceId	string	Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
availableUpgradeVersions	array	The list of cluster runtime version upgrades available for this cluster.
clusterCapacity	object	The capacity supported by this cluster.
clusterConnectionStatus	string	The latest heartbeat status between the cluster manager and the cluster. Known values are: "Connected", "Disconnected", "Timeout", and "Undefined". (Connected, Disconnected, Timeout, Undefined)
clusterExtendedLocation	object	The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.
clusterLocation	string	The customer-provided location information to identify where the cluster resides.
clusterManagerConnectionStatus	string	The latest connectivity status between cluster manager and the cluster. Known values are: "Connected" and "Unreachable". (Connected, Unreachable)
clusterManagerId	string	The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.
clusterServicePrincipal	object	Field Deprecated: Use managed identity to provide cluster privileges. The service principal to be used by the cluster during Arc Appliance installation.
clusterType	string	The type of rack configuration for the cluster. Required. Known values are: "SingleRack" and "MultiRack". (SingleRack, MultiRack)
clusterVersion	string	The current runtime version of the cluster. Required.
commandOutputSettings	object	The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
computeDeploymentThreshold	object	The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
computeRackDefinitions	array	The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.
detailedStatus	string	The current detailed status of the cluster. Known values are: "PendingDeployment", "Deploying", "Running", "Updating", "UpdatePaused", "Degraded", "Deleting", "Disconnected", and "Failed". (PendingDeployment, Deploying, Running, Updating, UpdatePaused, Degraded, Deleting, Disconnected, Failed)
detailedStatusMessage	string	The descriptive message about the detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
hybridAksExtendedLocation	object	Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).
identity	object	The managed service identities assigned to this resource.
kind	string	The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager. Known values are: "Nexus" and "AzureLocal". (Nexus, AzureLocal)
lastSuccessfulVersionUpdateTime	string (date-time)	The date and time of the end of the last successful version update for the cluster.
location	string	The geo-location where the resource lives. Required.
managedCredentials	array	The list of credentials that are managed for the cluster and can be rotated on-demand.
managedResourceGroupConfiguration	object	The configuration of the managed resource group associated with the resource.
manualActionCount	integer	The count of Manual Action Taken (MAT) events that have not been validated.
networkFabricId	string	The resource ID of the Network Fabric associated with the cluster. Required.
provisioningState	string	The provisioning state of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Validating", and "Updating". (Succeeded, Failed, Canceled, Accepted, Validating, Updating)
runtimeProtectionConfiguration	object	The settings for cluster runtime protection.
secretArchive	object	The configuration for use of a key vault to store secrets for later retrieval by the operator.
secretArchiveSettings	object	The settings for the secret archive used to hold credentials for the cluster.
supportExpiryDate	string	The support end date of the runtime version of the cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStrategy	object	The strategy for updating the cluster.
vulnerabilityScanningSettings	object	The settings for how security vulnerability scanning is applied to the cluster.
workloadResourceIds	array	The list of workload resource IDs that are hosted within this cluster.

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 properties of the provided cluster.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of clusters in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of clusters in the provided subscription.
create_or_update	insert	resource_group_name, cluster_name, subscription_id, location, properties, extendedLocation		Create a new cluster or update the properties of the cluster if it exists.
update	update	resource_group_name, cluster_name, subscription_id		Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
create_or_update	replace	resource_group_name, cluster_name, subscription_id, location, properties, extendedLocation		Create a new cluster or update the properties of the cluster if it exists.
delete	delete	resource_group_name, cluster_name, subscription_id		Delete the provided cluster.
continue_update_version	exec	resource_group_name, cluster_name, subscription_id		Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.
deploy	exec	resource_group_name, cluster_name, subscription_id		Deploy the cluster using the rack configuration provided during creation.
inspect	exec	resource_group_name, cluster_name, subscription_id		Trigger an inspection of the cluster to perform validation and optional corrective actions based on the supplied additional actions and filters.
rotate_credential	exec	resource_group_name, cluster_name, subscription_id, credentials		Rotate the specified cluster credential.
scan_runtime	exec	resource_group_name, cluster_name, subscription_id		Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.
update_version	exec	resource_group_name, cluster_name, subscription_id, targetClusterVersion		Update the version of the provided cluster to one of the available supported versions.

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
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get properties of the provided cluster.

SELECT
id,
name,
actionStates,
aggregatorOrSingleRackDefinition,
analyticsOutputSettings,
analyticsWorkspaceId,
availableUpgradeVersions,
clusterCapacity,
clusterConnectionStatus,
clusterExtendedLocation,
clusterLocation,
clusterManagerConnectionStatus,
clusterManagerId,
clusterServicePrincipal,
clusterType,
clusterVersion,
commandOutputSettings,
computeDeploymentThreshold,
computeRackDefinitions,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
hybridAksExtendedLocation,
identity,
kind,
lastSuccessfulVersionUpdateTime,
location,
managedCredentials,
managedResourceGroupConfiguration,
manualActionCount,
networkFabricId,
provisioningState,
runtimeProtectionConfiguration,
secretArchive,
secretArchiveSettings,
supportExpiryDate,
systemData,
tags,
type,
updateStrategy,
vulnerabilityScanningSettings,
workloadResourceIds
FROM azure_extras.network_cloud.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

Get a list of clusters in the provided resource group.

SELECT
id,
name,
actionStates,
aggregatorOrSingleRackDefinition,
analyticsOutputSettings,
analyticsWorkspaceId,
availableUpgradeVersions,
clusterCapacity,
clusterConnectionStatus,
clusterExtendedLocation,
clusterLocation,
clusterManagerConnectionStatus,
clusterManagerId,
clusterServicePrincipal,
clusterType,
clusterVersion,
commandOutputSettings,
computeDeploymentThreshold,
computeRackDefinitions,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
hybridAksExtendedLocation,
identity,
kind,
lastSuccessfulVersionUpdateTime,
location,
managedCredentials,
managedResourceGroupConfiguration,
manualActionCount,
networkFabricId,
provisioningState,
runtimeProtectionConfiguration,
secretArchive,
secretArchiveSettings,
supportExpiryDate,
systemData,
tags,
type,
updateStrategy,
vulnerabilityScanningSettings,
workloadResourceIds
FROM azure_extras.network_cloud.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of clusters in the provided subscription.

SELECT
id,
name,
actionStates,
aggregatorOrSingleRackDefinition,
analyticsOutputSettings,
analyticsWorkspaceId,
availableUpgradeVersions,
clusterCapacity,
clusterConnectionStatus,
clusterExtendedLocation,
clusterLocation,
clusterManagerConnectionStatus,
clusterManagerId,
clusterServicePrincipal,
clusterType,
clusterVersion,
commandOutputSettings,
computeDeploymentThreshold,
computeRackDefinitions,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
hybridAksExtendedLocation,
identity,
kind,
lastSuccessfulVersionUpdateTime,
location,
managedCredentials,
managedResourceGroupConfiguration,
manualActionCount,
networkFabricId,
provisioningState,
runtimeProtectionConfiguration,
secretArchive,
secretArchiveSettings,
supportExpiryDate,
systemData,
tags,
type,
updateStrategy,
vulnerabilityScanningSettings,
workloadResourceIds
FROM azure_extras.network_cloud.clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a new cluster or update the properties of the cluster if it exists.

INSERT INTO azure_extras.network_cloud.clusters (
tags,
location,
properties,
extendedLocation,
identity,
kind,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ identity }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
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: |
      The list of the resource properties. Required.
    value:
      aggregatorOrSingleRackDefinition:
        availabilityZone: "{{ availabilityZone }}"
        bareMetalMachineConfigurationData:
          - bmcConnectionString: "{{ bmcConnectionString }}"
            bmcCredentials:
              password: "{{ password }}"
              username: "{{ username }}"
            bmcMacAddress: "{{ bmcMacAddress }}"
            bootMacAddress: "{{ bootMacAddress }}"
            machineDetails: "{{ machineDetails }}"
            machineName: "{{ machineName }}"
            rackSlot: {{ rackSlot }}
            serialNumber: "{{ serialNumber }}"
        networkRackId: "{{ networkRackId }}"
        rackLocation: "{{ rackLocation }}"
        rackSerialNumber: "{{ rackSerialNumber }}"
        rackSkuId: "{{ rackSkuId }}"
        storageApplianceConfigurationData:
          - adminCredentials:
              password: "{{ password }}"
              username: "{{ username }}"
            rackSlot: {{ rackSlot }}
            serialNumber: "{{ serialNumber }}"
            storageApplianceName: "{{ storageApplianceName }}"
      analyticsOutputSettings:
        analyticsWorkspaceId: "{{ analyticsWorkspaceId }}"
        associatedIdentity:
          identityType: "{{ identityType }}"
          userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
      analyticsWorkspaceId: "{{ analyticsWorkspaceId }}"
      clusterLocation: "{{ clusterLocation }}"
      clusterServicePrincipal:
        applicationId: "{{ applicationId }}"
        password: "{{ password }}"
        principalId: "{{ principalId }}"
        tenantId: "{{ tenantId }}"
      clusterType: "{{ clusterType }}"
      clusterVersion: "{{ clusterVersion }}"
      commandOutputSettings:
        associatedIdentity:
          identityType: "{{ identityType }}"
          userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
        containerUrl: "{{ containerUrl }}"
        overrides:
          - associatedIdentity:
              identityType: "{{ identityType }}"
              userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
            commandOutputType: "{{ commandOutputType }}"
            containerUrl: "{{ containerUrl }}"
      computeDeploymentThreshold:
        grouping: "{{ grouping }}"
        type: "{{ type }}"
        value: {{ value }}
      computeRackDefinitions:
        - availabilityZone: "{{ availabilityZone }}"
          bareMetalMachineConfigurationData: "{{ bareMetalMachineConfigurationData }}"
          networkRackId: "{{ networkRackId }}"
          rackLocation: "{{ rackLocation }}"
          rackSerialNumber: "{{ rackSerialNumber }}"
          rackSkuId: "{{ rackSkuId }}"
          storageApplianceConfigurationData: "{{ storageApplianceConfigurationData }}"
      managedResourceGroupConfiguration:
        location: "{{ location }}"
        name: "{{ name }}"
      networkFabricId: "{{ networkFabricId }}"
      runtimeProtectionConfiguration:
        definitionUpdateMode: "{{ definitionUpdateMode }}"
        enforcementLevel: "{{ enforcementLevel }}"
      secretArchive:
        keyVaultId: "{{ keyVaultId }}"
        useKeyVault: "{{ useKeyVault }}"
      secretArchiveSettings:
        associatedIdentity:
          identityType: "{{ identityType }}"
          userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
        vaultUri: "{{ vaultUri }}"
      updateStrategy:
        maxUnavailable: {{ maxUnavailable }}
        strategyType: "{{ strategyType }}"
        thresholdType: "{{ thresholdType }}"
        thresholdValue: {{ thresholdValue }}
        waitTimeMinutes: {{ waitTimeMinutes }}
      vulnerabilityScanningSettings:
        containerScan: "{{ containerScan }}"
      actionStates:
        - actionType: "{{ actionType }}"
          correlationId: "{{ correlationId }}"
          endTime: "{{ endTime }}"
          message: "{{ message }}"
          startTime: "{{ startTime }}"
          status: "{{ status }}"
          stepStates: "{{ stepStates }}"
      availableUpgradeVersions:
        - controlImpact: "{{ controlImpact }}"
          expectedDuration: "{{ expectedDuration }}"
          impactDescription: "{{ impactDescription }}"
          supportExpiryDate: "{{ supportExpiryDate }}"
          targetClusterVersion: "{{ targetClusterVersion }}"
          workloadImpact: "{{ workloadImpact }}"
      clusterCapacity:
        availableApplianceStorageGB: {{ availableApplianceStorageGB }}
        availableCoreCount: {{ availableCoreCount }}
        availableHostStorageGB: {{ availableHostStorageGB }}
        availableMemoryGB: {{ availableMemoryGB }}
        totalApplianceStorageGB: {{ totalApplianceStorageGB }}
        totalCoreCount: {{ totalCoreCount }}
        totalHostStorageGB: {{ totalHostStorageGB }}
        totalMemoryGB: {{ totalMemoryGB }}
      clusterConnectionStatus: "{{ clusterConnectionStatus }}"
      clusterExtendedLocation:
        name: "{{ name }}"
        type: "{{ type }}"
      clusterManagerConnectionStatus: "{{ clusterManagerConnectionStatus }}"
      clusterManagerId: "{{ clusterManagerId }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      hybridAksExtendedLocation:
        name: "{{ name }}"
        type: "{{ type }}"
      lastSuccessfulVersionUpdateTime: "{{ lastSuccessfulVersionUpdateTime }}"
      managedCredentials:
        - "{{ managedCredentials }}"
      manualActionCount: {{ manualActionCount }}
      supportExpiryDate: "{{ supportExpiryDate }}"
      workloadResourceIds:
        - "{{ workloadResourceIds }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - 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: |
      The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager. Known values are: "Nexus" and "AzureLocal".
    valid_values: ['Nexus', 'AzureLocal']

UPDATE examples

update

Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

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

REPLACE examples

create_or_update

Create a new cluster or update the properties of the cluster if it exists.

REPLACE azure_extras.network_cloud.clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
identity = '{{ identity }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided cluster.

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

Lifecycle Methods

continue_update_version

Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.

EXEC azure_extras.network_cloud.clusters.continue_update_version 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"machineGroupTargetingMode": "{{ machineGroupTargetingMode }}", 
"safeguardMode": "{{ safeguardMode }}"
}'
;

deploy

Deploy the cluster using the rack configuration provided during creation.

EXEC azure_extras.network_cloud.clusters.deploy 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"skipValidationsForMachines": "{{ skipValidationsForMachines }}"
}'
;

inspect

Trigger an inspection of the cluster to perform validation and optional corrective actions based on the supplied additional actions and filters.

EXEC azure_extras.network_cloud.clusters.inspect 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"additionalActions": "{{ additionalActions }}", 
"filterDevices": "{{ filterDevices }}"
}'
;

rotate_credential

Rotate the specified cluster credential.

EXEC azure_extras.network_cloud.clusters.rotate_credential 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"credentials": "{{ credentials }}"
}'
;

scan_runtime

Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

EXEC azure_extras.network_cloud.clusters.scan_runtime 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"scanActivity": "{{ scanActivity }}"
}'
;

update_version

Update the version of the provided cluster to one of the available supported versions.

EXEC azure_extras.network_cloud.clusters.update_version 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"safeguardMode": "{{ safeguardMode }}", 
"targetClusterVersion": "{{ targetClusterVersion }}"
}'
;