deployment_settings

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

Overview

Name	deployment_settings
Type	Resource
Id	azure_stack.azure_stack_hci.deployment_settings

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.
arcNodeResourceIds	array	Azure resource ids of Arc machines to be part of cluster. Required.
deploymentConfiguration	object	Scale units will contains list of deployment data. Required.
deploymentMode	string	The deployment mode for cluster deployment. Required. Known values are: "Validate" and "Deploy". (Validate, Deploy)
operationType	string	The intended operation for a cluster. Known values are: "ClusterProvisioning" and "ClusterUpgrade". (ClusterProvisioning, ClusterUpgrade)
provisioningState	string	DeploymentSetting provisioning state. 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)
reportedProperties	object	Deployment Status reported from cluster.
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".

list_by_clusters

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.
arcNodeResourceIds	array	Azure resource ids of Arc machines to be part of cluster. Required.
deploymentConfiguration	object	Scale units will contains list of deployment data. Required.
deploymentMode	string	The deployment mode for cluster deployment. Required. Known values are: "Validate" and "Deploy". (Validate, Deploy)
operationType	string	The intended operation for a cluster. Known values are: "ClusterProvisioning" and "ClusterUpgrade". (ClusterProvisioning, ClusterUpgrade)
provisioningState	string	DeploymentSetting provisioning state. 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)
reportedProperties	object	Deployment Status reported from cluster.
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_group_name, cluster_name, subscription_id, deployment_settings_name		Get a DeploymentSetting.
list_by_clusters	select	resource_group_name, cluster_name, subscription_id		List DeploymentSetting resources by Clusters.
create_or_update	insert	resource_group_name, cluster_name, subscription_id, deployment_settings_name		Create a DeploymentSetting.
create_or_update	replace	resource_group_name, cluster_name, subscription_id, deployment_settings_name		Create a DeploymentSetting.
delete	delete	resource_group_name, cluster_name, subscription_id, deployment_settings_name		Delete a DeploymentSetting.

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.
deployment_settings_name	string	Name of Deployment Setting. Default value is "default".
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a DeploymentSetting.

SELECT
id,
name,
arcNodeResourceIds,
deploymentConfiguration,
deploymentMode,
operationType,
provisioningState,
reportedProperties,
systemData,
type
FROM azure_stack.azure_stack_hci.deployment_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND deployment_settings_name = '{{ deployment_settings_name }}' -- required
;

list_by_clusters

List DeploymentSetting resources by Clusters.

SELECT
id,
name,
arcNodeResourceIds,
deploymentConfiguration,
deploymentMode,
operationType,
provisioningState,
reportedProperties,
systemData,
type
FROM azure_stack.azure_stack_hci.deployment_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a DeploymentSetting.

INSERT INTO azure_stack.azure_stack_hci.deployment_settings (
properties,
resource_group_name,
cluster_name,
subscription_id,
deployment_settings_name
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}',
'{{ deployment_settings_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployment_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the deployment_settings resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the deployment_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the deployment_settings resource.
  - name: deployment_settings_name
    value: "{{ deployment_settings_name }}"
    description: Required parameter for the deployment_settings resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      arcNodeResourceIds:
        - "{{ arcNodeResourceIds }}"
      deploymentMode: "{{ deploymentMode }}"
      operationType: "{{ operationType }}"
      deploymentConfiguration:
        version: "{{ version }}"
        scaleUnits:
          - deploymentData:
              securitySettings:
                hvciProtection: {{ hvciProtection }}
                drtmProtection: {{ drtmProtection }}
                driftControlEnforced: {{ driftControlEnforced }}
                credentialGuardEnforced: {{ credentialGuardEnforced }}
                smbSigningEnforced: {{ smbSigningEnforced }}
                smbClusterEncryption: {{ smbClusterEncryption }}
                sideChannelMitigationEnforced: {{ sideChannelMitigationEnforced }}
                bitlockerBootVolume: {{ bitlockerBootVolume }}
                bitlockerDataVolumes: {{ bitlockerDataVolumes }}
                wdacEnforced: {{ wdacEnforced }}
              observability:
                streamingDataClient: {{ streamingDataClient }}
                euLocation: {{ euLocation }}
                episodicDataUpload: {{ episodicDataUpload }}
              cluster:
                name: "{{ name }}"
                witnessType: "{{ witnessType }}"
                witnessPath: "{{ witnessPath }}"
                cloudAccountName: "{{ cloudAccountName }}"
                azureServiceEndpoint: "{{ azureServiceEndpoint }}"
                hardwareClass: "{{ hardwareClass }}"
                clusterPattern: "{{ clusterPattern }}"
              identityProvider: "{{ identityProvider }}"
              storage:
                configurationMode: "{{ configurationMode }}"
                storageType: "{{ storageType }}"
                s2d: "{{ s2d }}"
                san: "{{ san }}"
              namingPrefix: "{{ namingPrefix }}"
              domainFqdn: "{{ domainFqdn }}"
              infrastructureNetwork:
                - subnetMask: "{{ subnetMask }}"
                  gateway: "{{ gateway }}"
                  ipPools: "{{ ipPools }}"
                  dnsServerConfig: "{{ dnsServerConfig }}"
                  dnsZones: "{{ dnsZones }}"
                  dnsServers: "{{ dnsServers }}"
                  useDhcp: {{ useDhcp }}
              physicalNodes:
                - name: "{{ name }}"
                  ipv4Address: "{{ ipv4Address }}"
              hostNetwork:
                intents: "{{ intents }}"
                storageNetworks: "{{ storageNetworks }}"
                sanNetworks: "{{ sanNetworks }}"
                storageConnectivitySwitchless: {{ storageConnectivitySwitchless }}
                enableStorageAutoIp: {{ enableStorageAutoIp }}
              sdnIntegration:
                networkController: "{{ networkController }}"
              isManagementCluster: {{ isManagementCluster }}
              adouPath: "{{ adouPath }}"
              secretsLocation: "{{ secretsLocation }}"
              secrets:
                - secretName: "{{ secretName }}"
                  eceSecretName: "{{ eceSecretName }}"
                  secretLocation: "{{ secretLocation }}"
              optionalServices:
                customLocation: "{{ customLocation }}"
              localAvailabilityZones:
                - localAvailabilityZoneName: "{{ localAvailabilityZoneName }}"
                  nodes: "{{ nodes }}"
              assemblyInfo:
                packageVersion: "{{ packageVersion }}"
                payload: "{{ payload }}"
            sbePartnerInfo:
              sbeDeploymentInfo:
                version: "{{ version }}"
                family: "{{ family }}"
                publisher: "{{ publisher }}"
                sbeManifestSource: "{{ sbeManifestSource }}"
                sbeManifestCreationDate: "{{ sbeManifestCreationDate }}"
              partnerProperties:
                - name: "{{ name }}"
                  value: "{{ value }}"
              credentialList:
                - secretName: "{{ secretName }}"
                  eceSecretName: "{{ eceSecretName }}"
                  secretLocation: "{{ secretLocation }}"
      reportedProperties:
        validationStatus:
          status: "{{ status }}"
          steps:
            - name: "{{ name }}"
              description: "{{ description }}"
              fullStepIndex: "{{ fullStepIndex }}"
              startTimeUtc: "{{ startTimeUtc }}"
              endTimeUtc: "{{ endTimeUtc }}"
              status: "{{ status }}"
              steps: "{{ steps }}"
              exception: "{{ exception }}"
        deploymentStatus:
          status: "{{ status }}"
          steps:
            - name: "{{ name }}"
              description: "{{ description }}"
              fullStepIndex: "{{ fullStepIndex }}"
              startTimeUtc: "{{ startTimeUtc }}"
              endTimeUtc: "{{ endTimeUtc }}"
              status: "{{ status }}"
              steps: "{{ steps }}"
              exception: "{{ exception }}"

REPLACE examples

create_or_update

Create a DeploymentSetting.

REPLACE azure_stack.azure_stack_hci.deployment_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND deployment_settings_name = '{{ deployment_settings_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a DeploymentSetting.

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