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

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_clusters

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, deploymentSettingsName		Get a DeploymentSetting
list_by_clusters	select	subscriptionId, resourceGroupName, clusterName		List DeploymentSetting resources by Clusters
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, deploymentSettingsName		Create a DeploymentSetting
delete	delete	subscriptionId, resourceGroupName, clusterName, deploymentSettingsName		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
clusterName	string	The name of the cluster.
deploymentSettingsName	string	Name of Deployment Setting
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a DeploymentSetting

SELECT
properties
FROM azure_stack.azure_stack_hci.deployment_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND deploymentSettingsName = '{{ deploymentSettingsName }}' -- required
;

list_by_clusters

List DeploymentSetting resources by Clusters

SELECT
properties
FROM azure_stack.azure_stack_hci.deployment_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create_or_update

Create a DeploymentSetting

INSERT INTO azure_stack.azure_stack_hci.deployment_settings (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
deploymentSettingsName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ deploymentSettingsName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: deployment_settings
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the deployment_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the deployment_settings resource.
    - name: clusterName
      value: string
      description: Required parameter for the deployment_settings resource.
    - name: deploymentSettingsName
      value: string
      description: Required parameter for the deployment_settings resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a DeploymentSetting

DELETE FROM azure_stack.azure_stack_hci.deployment_settings
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND deploymentSettingsName = '{{ deploymentSettingsName }}' --required
;