DeploymentStacksOperations interface

Package:

@azure/arm-resourcesdeploymentstacks

Interface representing a DeploymentStacks operations.

Properties

beginCreateOrUpdateAtManagementGroup
beginCreateOrUpdateAtManagementGroupAndWait
beginCreateOrUpdateAtResourceGroup
beginCreateOrUpdateAtResourceGroupAndWait
beginCreateOrUpdateAtSubscription
beginCreateOrUpdateAtSubscriptionAndWait
beginDeleteAtManagementGroup
beginDeleteAtManagementGroupAndWait
beginDeleteAtResourceGroup
beginDeleteAtResourceGroupAndWait
beginDeleteAtSubscription
beginDeleteAtSubscriptionAndWait
beginValidateStackAtManagementGroup
beginValidateStackAtManagementGroupAndWait
beginValidateStackAtResourceGroup
beginValidateStackAtResourceGroupAndWait
beginValidateStackAtSubscription
beginValidateStackAtSubscriptionAndWait
createOrUpdateAtManagementGroup	Creates or updates a Deployment stack at the specified scope.
createOrUpdateAtResourceGroup	Creates or updates a Deployment stack at the specified scope.
createOrUpdateAtSubscription	Creates or updates a Deployment stack at the specified scope.
deleteAtManagementGroup	Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.
deleteAtResourceGroup	Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.
deleteAtSubscription	Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.
exportTemplateAtManagementGroup	Exports the template used to create the Deployment stack at the specified scope.
exportTemplateAtResourceGroup	Exports the template used to create the Deployment stack at the specified scope.
exportTemplateAtSubscription	Exports the template used to create the Deployment stack at the specified scope.
getAtManagementGroup	Gets the Deployment stack with the given name.
getAtResourceGroup	Gets the Deployment stack with the given name.
getAtSubscription	Gets the Deployment stack with the given name.
listAtManagementGroup	Lists Deployment stacks at the specified scope.
listAtResourceGroup	Lists Deployment stacks at the specified scope.
listAtSubscription	Lists Deployment stacks at the specified scope.
validateStackAtManagementGroup	Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
validateStackAtResourceGroup	Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
validateStackAtSubscription	Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.

Property Details

beginCreateOrUpdateAtManagementGroup

Warning

This API is now deprecated.

use createOrUpdateAtManagementGroup instead

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

Property Value

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

beginCreateOrUpdateAtManagementGroupAndWait

Warning

This API is now deprecated.

use createOrUpdateAtManagementGroup instead

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

Property Value

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

beginCreateOrUpdateAtResourceGroup

Warning

This API is now deprecated.

use createOrUpdateAtResourceGroup instead

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

Property Value

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

beginCreateOrUpdateAtResourceGroupAndWait

Warning

This API is now deprecated.

use createOrUpdateAtResourceGroup instead

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

Property Value

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

beginCreateOrUpdateAtSubscription

Warning

This API is now deprecated.

use createOrUpdateAtSubscription instead

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

Property Value

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

beginCreateOrUpdateAtSubscriptionAndWait

Warning

This API is now deprecated.

use createOrUpdateAtSubscription instead

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

Property Value

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

beginDeleteAtManagementGroup

Warning

This API is now deprecated.

use deleteAtManagementGroup instead

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

Property Value

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

beginDeleteAtManagementGroupAndWait

Warning

This API is now deprecated.

use deleteAtManagementGroup instead

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

Property Value

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

beginDeleteAtResourceGroup

Warning

This API is now deprecated.

use deleteAtResourceGroup instead

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

Property Value

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

beginDeleteAtResourceGroupAndWait

Warning

This API is now deprecated.

use deleteAtResourceGroup instead

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

Property Value

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

beginDeleteAtSubscription

Warning

This API is now deprecated.

use deleteAtSubscription instead

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

Property Value

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

beginDeleteAtSubscriptionAndWait

Warning

This API is now deprecated.

use deleteAtSubscription instead

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

Property Value

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

beginValidateStackAtManagementGroup

Warning

This API is now deprecated.

use validateStackAtManagementGroup instead

beginValidateStackAtManagementGroup: (managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>

Property Value

(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>

beginValidateStackAtManagementGroupAndWait

Warning

This API is now deprecated.

use validateStackAtManagementGroup instead

beginValidateStackAtManagementGroupAndWait: (managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams) => Promise<DeploymentStackValidateResult>

Property Value

(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams) => Promise<DeploymentStackValidateResult>

beginValidateStackAtResourceGroup

Warning

This API is now deprecated.

use validateStackAtResourceGroup instead

beginValidateStackAtResourceGroup: (resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>

Property Value

(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>

beginValidateStackAtResourceGroupAndWait

Warning

This API is now deprecated.

use validateStackAtResourceGroup instead

beginValidateStackAtResourceGroupAndWait: (resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams) => Promise<DeploymentStackValidateResult>

Property Value

(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams) => Promise<DeploymentStackValidateResult>

beginValidateStackAtSubscription

Warning

This API is now deprecated.

use validateStackAtSubscription instead

beginValidateStackAtSubscription: (deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>

Property Value

(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams) => Promise<SimplePollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>>

beginValidateStackAtSubscriptionAndWait

Warning

This API is now deprecated.

use validateStackAtSubscription instead

beginValidateStackAtSubscriptionAndWait: (deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams) => Promise<DeploymentStackValidateResult>

Property Value

(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams) => Promise<DeploymentStackValidateResult>

createOrUpdateAtManagementGroup

Creates or updates a Deployment stack at the specified scope.

createOrUpdateAtManagementGroup: (managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams) => PollerLike<OperationState<DeploymentStack>, DeploymentStack>

Property Value

(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams) => PollerLike<OperationState<DeploymentStack>, DeploymentStack>

createOrUpdateAtResourceGroup

Creates or updates a Deployment stack at the specified scope.

createOrUpdateAtResourceGroup: (resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams) => PollerLike<OperationState<DeploymentStack>, DeploymentStack>

Property Value

(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams) => PollerLike<OperationState<DeploymentStack>, DeploymentStack>

createOrUpdateAtSubscription

Creates or updates a Deployment stack at the specified scope.

createOrUpdateAtSubscription: (deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams) => PollerLike<OperationState<DeploymentStack>, DeploymentStack>

Property Value

(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams) => PollerLike<OperationState<DeploymentStack>, DeploymentStack>

deleteAtManagementGroup

Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.

deleteAtManagementGroup: (managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtManagementGroupOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtManagementGroupOptionalParams) => PollerLike<OperationState<void>, void>

deleteAtResourceGroup

Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.

deleteAtResourceGroup: (resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtResourceGroupOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtResourceGroupOptionalParams) => PollerLike<OperationState<void>, void>

deleteAtSubscription

Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.

deleteAtSubscription: (deploymentStackName: string, options?: DeploymentStacksDeleteAtSubscriptionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deploymentStackName: string, options?: DeploymentStacksDeleteAtSubscriptionOptionalParams) => PollerLike<OperationState<void>, void>

exportTemplateAtManagementGroup

Exports the template used to create the Deployment stack at the specified scope.

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

Property Value

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

exportTemplateAtResourceGroup

Exports the template used to create the Deployment stack at the specified scope.

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

Property Value

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

exportTemplateAtSubscription

Exports the template used to create the Deployment stack at the specified scope.

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

Property Value

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

getAtManagementGroup

Gets the Deployment stack with the given name.

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

Property Value

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

getAtResourceGroup

Gets the Deployment stack with the given name.

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

Property Value

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

getAtSubscription

Gets the Deployment stack with the given name.

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

Property Value

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

listAtManagementGroup

Lists Deployment stacks at the specified scope.

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

Property Value

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

listAtResourceGroup

Lists Deployment stacks at the specified scope.

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

Property Value

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

listAtSubscription

Lists Deployment stacks at the specified scope.

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

Property Value

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

validateStackAtManagementGroup

Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.

validateStackAtManagementGroup: (managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams) => PollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>

Property Value

(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtManagementGroupOptionalParams) => PollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>

validateStackAtResourceGroup

Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.

validateStackAtResourceGroup: (resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams) => PollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>

Property Value

(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtResourceGroupOptionalParams) => PollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>

validateStackAtSubscription

Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.

validateStackAtSubscription: (deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams) => PollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>

Property Value

(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksValidateStackAtSubscriptionOptionalParams) => PollerLike<OperationState<DeploymentStackValidateResult>, DeploymentStackValidateResult>