DeploymentStacks interface

Interface representing a DeploymentStacks.

Methods

beginCreateOrUpdateAtManagementGroup(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams)

Creates or updates a Deployment Stack.

beginCreateOrUpdateAtManagementGroupAndWait(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams)

Creates or updates a Deployment Stack.

beginCreateOrUpdateAtResourceGroup(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams)

Creates or updates a Deployment Stack.

beginCreateOrUpdateAtResourceGroupAndWait(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams)

Creates or updates a Deployment Stack.

beginCreateOrUpdateAtSubscription(string, DeploymentStack, DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams)

Creates or updates a Deployment Stack.

beginCreateOrUpdateAtSubscriptionAndWait(string, DeploymentStack, DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams)

Creates or updates a Deployment Stack.

beginDeleteAtManagementGroup(string, string, DeploymentStacksDeleteAtManagementGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

beginDeleteAtManagementGroupAndWait(string, string, DeploymentStacksDeleteAtManagementGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

beginDeleteAtResourceGroup(string, string, DeploymentStacksDeleteAtResourceGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

beginDeleteAtResourceGroupAndWait(string, string, DeploymentStacksDeleteAtResourceGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

beginDeleteAtSubscription(string, DeploymentStacksDeleteAtSubscriptionOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

beginDeleteAtSubscriptionAndWait(string, DeploymentStacksDeleteAtSubscriptionOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

exportTemplateAtManagementGroup(string, string, DeploymentStacksExportTemplateAtManagementGroupOptionalParams)

Exports the template used to create the deployment stack.

exportTemplateAtResourceGroup(string, string, DeploymentStacksExportTemplateAtResourceGroupOptionalParams)

Exports the template used to create the deployment stack.

exportTemplateAtSubscription(string, DeploymentStacksExportTemplateAtSubscriptionOptionalParams)

Exports the template used to create the deployment stack.

getAtManagementGroup(string, string, DeploymentStacksGetAtManagementGroupOptionalParams)

Gets a Deployment Stack with a given name.

getAtResourceGroup(string, string, DeploymentStacksGetAtResourceGroupOptionalParams)

Gets a Deployment Stack with a given name.

getAtSubscription(string, DeploymentStacksGetAtSubscriptionOptionalParams)

Gets a Deployment Stack with a given name.

listAtManagementGroup(string, DeploymentStacksListAtManagementGroupOptionalParams)

Lists all the Deployment Stacks within the specified management group.

listAtResourceGroup(string, DeploymentStacksListAtResourceGroupOptionalParams)

Lists all the Deployment Stacks within the specified resource group.

listAtSubscription(DeploymentStacksListAtSubscriptionOptionalParams)

Lists all the Deployment Stacks within the specified subscription.

Method Details

beginCreateOrUpdateAtManagementGroup(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams)

Creates or updates a Deployment Stack.

function beginCreateOrUpdateAtManagementGroup(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>

Parameters

managementGroupId

string

Management Group.

deploymentStackName

string

Name of the deployment stack.

deploymentStack
DeploymentStack

Deployment Stack supplied to the operation.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>

beginCreateOrUpdateAtManagementGroupAndWait(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams)

Creates or updates a Deployment Stack.

function beginCreateOrUpdateAtManagementGroupAndWait(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams): Promise<DeploymentStack>

Parameters

managementGroupId

string

Management Group.

deploymentStackName

string

Name of the deployment stack.

deploymentStack
DeploymentStack

Deployment Stack supplied to the operation.

Returns

Promise<DeploymentStack>

beginCreateOrUpdateAtResourceGroup(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams)

Creates or updates a Deployment Stack.

function beginCreateOrUpdateAtResourceGroup(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentStackName

string

Name of the deployment stack.

deploymentStack
DeploymentStack

Deployment Stack supplied to the operation.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>

beginCreateOrUpdateAtResourceGroupAndWait(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams)

Creates or updates a Deployment Stack.

function beginCreateOrUpdateAtResourceGroupAndWait(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams): Promise<DeploymentStack>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentStackName

string

Name of the deployment stack.

deploymentStack
DeploymentStack

Deployment Stack supplied to the operation.

Returns

Promise<DeploymentStack>

beginCreateOrUpdateAtSubscription(string, DeploymentStack, DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams)

Creates or updates a Deployment Stack.

function beginCreateOrUpdateAtSubscription(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>

Parameters

deploymentStackName

string

Name of the deployment stack.

deploymentStack
DeploymentStack

Deployment Stack supplied to the operation.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>

beginCreateOrUpdateAtSubscriptionAndWait(string, DeploymentStack, DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams)

Creates or updates a Deployment Stack.

function beginCreateOrUpdateAtSubscriptionAndWait(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams): Promise<DeploymentStack>

Parameters

deploymentStackName

string

Name of the deployment stack.

deploymentStack
DeploymentStack

Deployment Stack supplied to the operation.

Returns

Promise<DeploymentStack>

beginDeleteAtManagementGroup(string, string, DeploymentStacksDeleteAtManagementGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

function beginDeleteAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtManagementGroupOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

managementGroupId

string

Management Group.

deploymentStackName

string

Name of the deployment stack.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAtManagementGroupAndWait(string, string, DeploymentStacksDeleteAtManagementGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

function beginDeleteAtManagementGroupAndWait(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtManagementGroupOptionalParams): Promise<void>

Parameters

managementGroupId

string

Management Group.

deploymentStackName

string

Name of the deployment stack.

Returns

Promise<void>

beginDeleteAtResourceGroup(string, string, DeploymentStacksDeleteAtResourceGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

function beginDeleteAtResourceGroup(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentStackName

string

Name of the deployment stack.

options
DeploymentStacksDeleteAtResourceGroupOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAtResourceGroupAndWait(string, string, DeploymentStacksDeleteAtResourceGroupOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

function beginDeleteAtResourceGroupAndWait(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtResourceGroupOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentStackName

string

Name of the deployment stack.

options
DeploymentStacksDeleteAtResourceGroupOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteAtSubscription(string, DeploymentStacksDeleteAtSubscriptionOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

function beginDeleteAtSubscription(deploymentStackName: string, options?: DeploymentStacksDeleteAtSubscriptionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

deploymentStackName

string

Name of the deployment stack.

options
DeploymentStacksDeleteAtSubscriptionOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAtSubscriptionAndWait(string, DeploymentStacksDeleteAtSubscriptionOptionalParams)

Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content.

function beginDeleteAtSubscriptionAndWait(deploymentStackName: string, options?: DeploymentStacksDeleteAtSubscriptionOptionalParams): Promise<void>

Parameters

deploymentStackName

string

Name of the deployment stack.

options
DeploymentStacksDeleteAtSubscriptionOptionalParams

The options parameters.

Returns

Promise<void>

exportTemplateAtManagementGroup(string, string, DeploymentStacksExportTemplateAtManagementGroupOptionalParams)

Exports the template used to create the deployment stack.

function exportTemplateAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksExportTemplateAtManagementGroupOptionalParams): Promise<DeploymentStackTemplateDefinition>

Parameters

managementGroupId

string

Management Group.

deploymentStackName

string

Name of the deployment stack.

Returns

exportTemplateAtResourceGroup(string, string, DeploymentStacksExportTemplateAtResourceGroupOptionalParams)

Exports the template used to create the deployment stack.

function exportTemplateAtResourceGroup(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksExportTemplateAtResourceGroupOptionalParams): Promise<DeploymentStackTemplateDefinition>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentStackName

string

Name of the deployment stack.

Returns

exportTemplateAtSubscription(string, DeploymentStacksExportTemplateAtSubscriptionOptionalParams)

Exports the template used to create the deployment stack.

function exportTemplateAtSubscription(deploymentStackName: string, options?: DeploymentStacksExportTemplateAtSubscriptionOptionalParams): Promise<DeploymentStackTemplateDefinition>

Parameters

deploymentStackName

string

Name of the deployment stack.

Returns

getAtManagementGroup(string, string, DeploymentStacksGetAtManagementGroupOptionalParams)

Gets a Deployment Stack with a given name.

function getAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksGetAtManagementGroupOptionalParams): Promise<DeploymentStack>

Parameters

managementGroupId

string

Management Group.

deploymentStackName

string

Name of the deployment stack.

options
DeploymentStacksGetAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<DeploymentStack>

getAtResourceGroup(string, string, DeploymentStacksGetAtResourceGroupOptionalParams)

Gets a Deployment Stack with a given name.

function getAtResourceGroup(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksGetAtResourceGroupOptionalParams): Promise<DeploymentStack>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentStackName

string

Name of the deployment stack.

options
DeploymentStacksGetAtResourceGroupOptionalParams

The options parameters.

Returns

Promise<DeploymentStack>

getAtSubscription(string, DeploymentStacksGetAtSubscriptionOptionalParams)

Gets a Deployment Stack with a given name.

function getAtSubscription(deploymentStackName: string, options?: DeploymentStacksGetAtSubscriptionOptionalParams): Promise<DeploymentStack>

Parameters

deploymentStackName

string

Name of the deployment stack.

options
DeploymentStacksGetAtSubscriptionOptionalParams

The options parameters.

Returns

Promise<DeploymentStack>

listAtManagementGroup(string, DeploymentStacksListAtManagementGroupOptionalParams)

Lists all the Deployment Stacks within the specified management group.

function listAtManagementGroup(managementGroupId: string, options?: DeploymentStacksListAtManagementGroupOptionalParams): PagedAsyncIterableIterator<DeploymentStack, DeploymentStack[], PageSettings>

Parameters

managementGroupId

string

Management Group.

options
DeploymentStacksListAtManagementGroupOptionalParams

The options parameters.

Returns

listAtResourceGroup(string, DeploymentStacksListAtResourceGroupOptionalParams)

Lists all the Deployment Stacks within the specified resource group.

function listAtResourceGroup(resourceGroupName: string, options?: DeploymentStacksListAtResourceGroupOptionalParams): PagedAsyncIterableIterator<DeploymentStack, DeploymentStack[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
DeploymentStacksListAtResourceGroupOptionalParams

The options parameters.

Returns

listAtSubscription(DeploymentStacksListAtSubscriptionOptionalParams)

Lists all the Deployment Stacks within the specified subscription.

function listAtSubscription(options?: DeploymentStacksListAtSubscriptionOptionalParams): PagedAsyncIterableIterator<DeploymentStack, DeploymentStack[], PageSettings>

Parameters

options
DeploymentStacksListAtSubscriptionOptionalParams

The options parameters.

Returns