DeploymentStacks interface
Interface representing a DeploymentStacks.
Methods
Method Details
beginCreateOrUpdateAtManagementGroup(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams)
Creates or updates a Deployment stack at Management Group scope.
function beginCreateOrUpdateAtManagementGroup(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>Parameters
- managementGroupId
-
string
Management Group id.
- deploymentStackName
-
string
Name of the deployment stack.
- deploymentStack
- DeploymentStack
Deployment stack supplied to the operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>
beginCreateOrUpdateAtManagementGroupAndWait(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams)
Creates or updates a Deployment stack at Management Group scope.
function beginCreateOrUpdateAtManagementGroupAndWait(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams): Promise<DeploymentStack>Parameters
- managementGroupId
-
string
Management Group id.
- deploymentStackName
-
string
Name of the deployment stack.
- deploymentStack
- DeploymentStack
Deployment stack supplied to the operation.
The options parameters.
Returns
Promise<DeploymentStack>
beginCreateOrUpdateAtResourceGroup(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams)
Creates or updates a Deployment stack at Resource Group scope.
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>
beginCreateOrUpdateAtResourceGroupAndWait(string, string, DeploymentStack, DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams)
Creates or updates a Deployment stack at Resource Group scope.
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.
The options parameters.
Returns
Promise<DeploymentStack>
beginCreateOrUpdateAtSubscription(string, DeploymentStack, DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams)
Creates or updates a Deployment stack at Subscription scope.
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStack>, DeploymentStack>>
beginCreateOrUpdateAtSubscriptionAndWait(string, DeploymentStack, DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams)
Creates or updates a Deployment stack at Subscription scope.
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.
The options parameters.
Returns
Promise<DeploymentStack>
beginDeleteAtManagementGroup(string, string, DeploymentStacksDeleteAtManagementGroupOptionalParams)
Deletes a Deployment stack by name at Management Group scope. 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 id.
- deploymentStackName
-
string
Name of the deployment stack.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAtManagementGroupAndWait(string, string, DeploymentStacksDeleteAtManagementGroupOptionalParams)
Deletes a Deployment stack by name at Management Group scope. When operation completes, status code 200 returned without content.
function beginDeleteAtManagementGroupAndWait(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtManagementGroupOptionalParams): Promise<void>Parameters
- managementGroupId
-
string
Management Group id.
- deploymentStackName
-
string
Name of the deployment stack.
The options parameters.
Returns
Promise<void>
beginDeleteAtResourceGroup(string, string, DeploymentStacksDeleteAtResourceGroupOptionalParams)
Deletes a Deployment stack by name at Resource Group scope. 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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAtResourceGroupAndWait(string, string, DeploymentStacksDeleteAtResourceGroupOptionalParams)
Deletes a Deployment stack by name at Resource Group scope. 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.
The options parameters.
Returns
Promise<void>
beginDeleteAtSubscription(string, DeploymentStacksDeleteAtSubscriptionOptionalParams)
Deletes a Deployment stack by name at Subscription scope. 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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAtSubscriptionAndWait(string, DeploymentStacksDeleteAtSubscriptionOptionalParams)
Deletes a Deployment stack by name at Subscription scope. 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.
The options parameters.
Returns
Promise<void>
beginValidateStackAtManagementGroup(string, string, DeploymentStack, DeploymentStacksValidateStackAtManagementGroupOptionalParams)
Runs preflight validation on the Management Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
function beginValidateStackAtManagementGroup(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>Parameters
- managementGroupId
-
string
Management Group id.
- deploymentStackName
-
string
Name of the deployment stack.
- deploymentStack
- DeploymentStack
Deployment stack to validate.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>
beginValidateStackAtManagementGroupAndWait(string, string, DeploymentStack, DeploymentStacksValidateStackAtManagementGroupOptionalParams)
Runs preflight validation on the Management Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
function beginValidateStackAtManagementGroupAndWait(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams): Promise<DeploymentStackValidateResult>Parameters
- managementGroupId
-
string
Management Group id.
- deploymentStackName
-
string
Name of the deployment stack.
- deploymentStack
- DeploymentStack
Deployment stack to validate.
The options parameters.
Returns
Promise<DeploymentStackValidateResult>
beginValidateStackAtResourceGroup(string, string, DeploymentStack, DeploymentStacksValidateStackAtResourceGroupOptionalParams)
Runs preflight validation on the Resource Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
function beginValidateStackAtResourceGroup(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>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 to validate.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>
beginValidateStackAtResourceGroupAndWait(string, string, DeploymentStack, DeploymentStacksValidateStackAtResourceGroupOptionalParams)
Runs preflight validation on the Resource Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
function beginValidateStackAtResourceGroupAndWait(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams): Promise<DeploymentStackValidateResult>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 to validate.
The options parameters.
Returns
Promise<DeploymentStackValidateResult>
beginValidateStackAtSubscription(string, DeploymentStack, DeploymentStacksValidateStackAtSubscriptionOptionalParams)
Runs preflight validation on the Subscription scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
function beginValidateStackAtSubscription(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>Parameters
- deploymentStackName
-
string
Name of the deployment stack.
- deploymentStack
- DeploymentStack
Deployment stack to validate.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>
beginValidateStackAtSubscriptionAndWait(string, DeploymentStack, DeploymentStacksValidateStackAtSubscriptionOptionalParams)
Runs preflight validation on the Subscription scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
function beginValidateStackAtSubscriptionAndWait(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams): Promise<DeploymentStackValidateResult>Parameters
- deploymentStackName
-
string
Name of the deployment stack.
- deploymentStack
- DeploymentStack
Deployment stack to validate.
The options parameters.
Returns
Promise<DeploymentStackValidateResult>
exportTemplateAtManagementGroup(string, string, DeploymentStacksExportTemplateAtManagementGroupOptionalParams)
Exports the template used to create the Deployment stack at Management Group scope.
function exportTemplateAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksExportTemplateAtManagementGroupOptionalParams): Promise<DeploymentStackTemplateDefinition>Parameters
- managementGroupId
-
string
Management Group id.
- deploymentStackName
-
string
Name of the deployment stack.
The options parameters.
Returns
Promise<DeploymentStackTemplateDefinition>
exportTemplateAtResourceGroup(string, string, DeploymentStacksExportTemplateAtResourceGroupOptionalParams)
Exports the template used to create the Deployment stack at Resource Group scope.
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.
The options parameters.
Returns
Promise<DeploymentStackTemplateDefinition>
exportTemplateAtSubscription(string, DeploymentStacksExportTemplateAtSubscriptionOptionalParams)
Exports the template used to create the Deployment stack at Subscription scope.
function exportTemplateAtSubscription(deploymentStackName: string, options?: DeploymentStacksExportTemplateAtSubscriptionOptionalParams): Promise<DeploymentStackTemplateDefinition>Parameters
- deploymentStackName
-
string
Name of the deployment stack.
The options parameters.
Returns
Promise<DeploymentStackTemplateDefinition>
getAtManagementGroup(string, string, DeploymentStacksGetAtManagementGroupOptionalParams)
Gets a Deployment stack with a given name at Management Group scope.
function getAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksGetAtManagementGroupOptionalParams): Promise<DeploymentStack>Parameters
- managementGroupId
-
string
Management Group id.
- deploymentStackName
-
string
Name of the deployment stack.
The options parameters.
Returns
Promise<DeploymentStack>
getAtResourceGroup(string, string, DeploymentStacksGetAtResourceGroupOptionalParams)
Gets a Deployment stack with a given name at Resource Group scope.
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.
The options parameters.
Returns
Promise<DeploymentStack>
getAtSubscription(string, DeploymentStacksGetAtSubscriptionOptionalParams)
Gets a Deployment stack with a given name at Subscription scope.
function getAtSubscription(deploymentStackName: string, options?: DeploymentStacksGetAtSubscriptionOptionalParams): Promise<DeploymentStack>Parameters
- deploymentStackName
-
string
Name of the deployment stack.
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 id.
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.
The options parameters.
Returns
listAtSubscription(DeploymentStacksListAtSubscriptionOptionalParams)
Lists all the Deployment stacks within the specified Subscription.
function listAtSubscription(options?: DeploymentStacksListAtSubscriptionOptionalParams): PagedAsyncIterableIterator<DeploymentStack, DeploymentStack[], PageSettings>Parameters
The options parameters.