@azure/arm-resourcesdeploymentstacks package

Interfaces

ActionOnUnmanage

Defines the behavior of resources that are no longer managed after the stack is updated or deleted.

DenySettings

Defines how resources deployed by the Deployment stack are locked.

DeploymentExtension

Details about the usage of a deployment extension.

DeploymentExtensionConfig

The configuration of a deployment extension. The keys of this object should align with the extension config schema.

DeploymentExtensionConfigItem

The value or how to get a value for an extension config property.

DeploymentExternalInput

Deployment external input for parameterization.

DeploymentExternalInputDefinition

Deployment external input definition for parameterization.

DeploymentParameter

Deployment parameter for the template.

DeploymentStack

Deployment stack object.

DeploymentStackProperties

Deployment stack properties.

DeploymentStackTemplateDefinition

Export Template specific properties of the Deployment stack.

DeploymentStackValidateProperties

The Deployment stack validation result details.

DeploymentStackValidateResult

The Deployment stack validation result.

DeploymentStacksChangeBase

Base model for properties with the before-and-after property values.

DeploymentStacksChangeBaseDenyStatusMode

Base model for properties with the before-and-after property values.

DeploymentStacksChangeBaseDeploymentStacksManagementStatus

Base model for properties with the before-and-after property values.

DeploymentStacksChangeDeltaDenySettings

Model to show the before-and-after property values, along with the delta between them.

DeploymentStacksChangeDeltaRecord

Model to show the before-and-after property values, along with the delta between them.

DeploymentStacksClientOptionalParams

Optional parameters for the client.

DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams

Optional parameters.

DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams

Optional parameters.

DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams

Optional parameters.

DeploymentStacksDebugSetting

The debug setting.

DeploymentStacksDeleteAtManagementGroupOptionalParams

Optional parameters.

DeploymentStacksDeleteAtResourceGroupOptionalParams

Optional parameters.

DeploymentStacksDeleteAtSubscriptionOptionalParams

Optional parameters.

DeploymentStacksDiagnostic

The error additional info

DeploymentStacksExportTemplateAtManagementGroupOptionalParams

Optional parameters.

DeploymentStacksExportTemplateAtResourceGroupOptionalParams

Optional parameters.

DeploymentStacksExportTemplateAtSubscriptionOptionalParams

Optional parameters.

DeploymentStacksGetAtManagementGroupOptionalParams

Optional parameters.

DeploymentStacksGetAtResourceGroupOptionalParams

Optional parameters.

DeploymentStacksGetAtSubscriptionOptionalParams

Optional parameters.

DeploymentStacksListAtManagementGroupOptionalParams

Optional parameters.

DeploymentStacksListAtResourceGroupOptionalParams

Optional parameters.

DeploymentStacksListAtSubscriptionOptionalParams

Optional parameters.

DeploymentStacksOperations

Interface representing a DeploymentStacks operations.

DeploymentStacksParametersLink

Entity representing the reference to the deployment parameters.

DeploymentStacksTemplateLink

Entity representing the reference to the template.

DeploymentStacksValidateStackAtManagementGroupOptionalParams

Optional parameters.

DeploymentStacksValidateStackAtResourceGroupOptionalParams

Optional parameters.

DeploymentStacksValidateStackAtSubscriptionOptionalParams

Optional parameters.

DeploymentStacksWhatIfChange

Changes predicted to the deployment stack as a result of the what-if operation.

DeploymentStacksWhatIfPropertyChange

The predicted change to the resource property.

DeploymentStacksWhatIfResourceChange

Information about a single resource change predicted by What-If operation.

DeploymentStacksWhatIfResult

Deployment stack object.

DeploymentStacksWhatIfResultProperties

DeploymentStack WhatIfResult Properties

DeploymentStacksWhatIfResultsAtManagementGroupCreateOrUpdateOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtManagementGroupDeleteOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtManagementGroupGetOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtManagementGroupListOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtManagementGroupOperations

Interface representing a DeploymentStacksWhatIfResultsAtManagementGroup operations.

DeploymentStacksWhatIfResultsAtManagementGroupWhatIfOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtResourceGroupCreateOrUpdateOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtResourceGroupDeleteOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtResourceGroupGetOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtResourceGroupListOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtResourceGroupOperations

Interface representing a DeploymentStacksWhatIfResultsAtResourceGroup operations.

DeploymentStacksWhatIfResultsAtResourceGroupWhatIfOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtSubscriptionCreateOrUpdateOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtSubscriptionDeleteOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtSubscriptionGetOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtSubscriptionListOptionalParams

Optional parameters.

DeploymentStacksWhatIfResultsAtSubscriptionOperations

Interface representing a DeploymentStacksWhatIfResultsAtSubscription operations.

DeploymentStacksWhatIfResultsAtSubscriptionWhatIfOptionalParams

Optional parameters.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

KeyVaultParameterReference

Azure Key Vault parameter reference.

KeyVaultReference

Azure Key Vault reference.

ManagedResourceReference

The managed resource model.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceReference

The resourceId model.

ResourceReferenceExtended

The resourceId extended model. This is used to document failed resources with a resourceId and a corresponding error.

RestorePollerOptions
SimplePollerLike

A simple poller that can be used to poll a long running operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

Type Aliases

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DenySettingsMode

denySettings Mode that defines denied actions.
KnownDenySettingsMode can be used interchangeably with DenySettingsMode, this enum contains the known values that the service supports.

Known values supported by the service

denyDelete: Authorized users are able to read and modify the resources, but cannot delete.
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it.
none: No denyAssignments have been applied.

DenyStatusMode

denyAssignment settings applied to the resource.
KnownDenyStatusMode can be used interchangeably with DenyStatusMode, this enum contains the known values that the service supports.

Known values supported by the service

denyDelete: Authorized users are able to read and modify the resources, but cannot delete.
notSupported: Resource type does not support denyAssignments.
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack.
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it.
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.)
none: No denyAssignments have been applied.
unknown: The denyAssignment status is unknown.

DeploymentStackProvisioningState

State of the deployment stack.
KnownDeploymentStackProvisioningState can be used interchangeably with DeploymentStackProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

creating: The deployment stack is currently being created
validating: The deployment stack is currently being validated
waiting: The deployment stack is currently waiting
deploying: The deployment stack is currently deploying
canceling: The deployment stack is being cancelled
updatingDenyAssignments: The deployment stack is updating deny assignments
deletingResources: The deployment stack is deleting resources
succeeded: The deployment stack completed successfully
failed: The deployment stack has failed
canceled: The deployment stack has been cancelled
deleting: The deployment stack is being deleted
initializing: The deployment stack is currently being initialized
running: The deployment stack is currently performing an operation

DeploymentStacksDiagnosticLevel

Denotes the additional response level.
KnownDeploymentStacksDiagnosticLevel can be used interchangeably with DeploymentStacksDiagnosticLevel, this enum contains the known values that the service supports.

Known values supported by the service

info: Informational message.
warning: Warning message.
error: Error message.

DeploymentStacksManagementStatus

The management status of the deployment stack resource.
KnownDeploymentStacksManagementStatus can be used interchangeably with DeploymentStacksManagementStatus, this enum contains the known values that the service supports.

Known values supported by the service

managed: The resource is managed by the deployment stack.
unmanaged: The resource is not managed by the deployment stack.
unknown: The management state of the resource could not be determined.

DeploymentStacksWhatIfChangeCertainty

Denotes the confidence level of the predicted change.
KnownDeploymentStacksWhatIfChangeCertainty can be used interchangeably with DeploymentStacksWhatIfChangeCertainty, this enum contains the known values that the service supports.

Known values supported by the service

definite: The change is definite.
potential: The change may or may not happen, based on deployment-time conditions.

DeploymentStacksWhatIfChangeType

Type of change that will be made to the resource when the deployment is executed.
KnownDeploymentStacksWhatIfChangeType can be used interchangeably with DeploymentStacksWhatIfChangeType, this enum contains the known values that the service supports.

Known values supported by the service

create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed.
delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted from Azure after the deployment is executed.
detach: The resource exists in the current state and is missing from the desired state. The resource will be removed from the deployment stack, but will remain in Azure, after the deployment is executed.
modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change.
noChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change.
unsupported: The resource is not supported by What-If.

DeploymentStacksWhatIfPropertyChangeType

The type of property change.
KnownDeploymentStacksWhatIfPropertyChangeType can be used interchangeably with DeploymentStacksWhatIfPropertyChangeType, this enum contains the known values that the service supports.

Known values supported by the service

array: The property is an array and contains nested changes.
create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed.
delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed.
modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed.
noEffect: The property will not be set or updated.

ResourceStatusMode

Current management state of the resource in the deployment stack.
KnownResourceStatusMode can be used interchangeably with ResourceStatusMode, this enum contains the known values that the service supports.

Known values supported by the service

managed: This resource is managed by the deployment stack.
removeDenyFailed: Unable to remove the deny assignment on resource.
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually.

ResourcesWithoutDeleteSupportAction

Specifies an action for resources that do not support deletion.
KnownResourcesWithoutDeleteSupportAction can be used interchangeably with ResourcesWithoutDeleteSupportAction, this enum contains the known values that the service supports.

Known values supported by the service

detach: Detach the specified resources from the deployment stack and continue.
fail: Fail the deployment stack if resources cannot be deleted.

UnmanageActionManagementGroupMode

Specifies an action for a newly unmanaged resource.
KnownUnmanageActionManagementGroupMode can be used interchangeably with UnmanageActionManagementGroupMode, this enum contains the known values that the service supports.

Known values supported by the service

delete: Delete the management groups from Azure.
detach: Keep the management groups in Azure.

UnmanageActionResourceGroupMode

Specifies an action for a newly unmanaged resource group.
KnownUnmanageActionResourceGroupMode can be used interchangeably with UnmanageActionResourceGroupMode, this enum contains the known values that the service supports.

Known values supported by the service

delete: Delete the resource groups from Azure.
detach: Keep the resource groups in Azure.

UnmanageActionResourceMode

Specifies an action for a newly unmanaged resource.
KnownUnmanageActionResourceMode can be used interchangeably with UnmanageActionResourceMode, this enum contains the known values that the service supports.

Known values supported by the service

delete: Delete the resources from Azure
detach: Keep the resources in Azure

ValidationLevel

The level of validation performed on the deployment.
KnownValidationLevel can be used interchangeably with ValidationLevel, this enum contains the known values that the service supports.

Known values supported by the service

Template: Static analysis of the template is performed.
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource.
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownCreatedByType

The kind of entity that created the resource.

KnownDenySettingsMode

denySettings Mode that defines denied actions.

KnownDenyStatusMode

denyAssignment settings applied to the resource.

KnownDeploymentStackProvisioningState

State of the deployment stack.

KnownDeploymentStacksDiagnosticLevel

Denotes the additional response level.

KnownDeploymentStacksManagementStatus

The management status of the deployment stack resource.

KnownDeploymentStacksWhatIfChangeCertainty

Denotes the confidence level of the predicted change.

KnownDeploymentStacksWhatIfChangeType

Type of change that will be made to the resource when the deployment is executed.

KnownDeploymentStacksWhatIfPropertyChangeType

The type of property change.

KnownResourceStatusMode

Current management state of the resource in the deployment stack.

KnownResourcesWithoutDeleteSupportAction

Specifies an action for resources that do not support deletion.

KnownUnmanageActionManagementGroupMode

Specifies an action for a newly unmanaged resource.

KnownUnmanageActionResourceGroupMode

Specifies an action for a newly unmanaged resource group.

KnownUnmanageActionResourceMode

Specifies an action for a newly unmanaged resource.

KnownValidationLevel

The level of validation performed on the deployment.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(DeploymentStacksClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(DeploymentStacksClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: DeploymentStacksClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>