@azure/arm-resourcesdeploymentstacks package

Classes

DeploymentStacksClient

Interfaces

ActionOnUnmanage	Defines the behavior of resources that are no longer managed after the stack is updated or deleted.
AzureResourceBase	Common properties for all Azure resources.
DenySettings	Defines how resources deployed by the Deployment stack are locked.
DeploymentParameter	Deployment parameter for the template.
DeploymentStack	Deployment stack object.
DeploymentStackListResult	List of Deployment stacks.
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.
DeploymentStacks	Interface representing a DeploymentStacks.
DeploymentStacksClientOptionalParams	Optional parameters.
DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams	Optional parameters.
DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams	Optional parameters.
DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams	Optional parameters.
DeploymentStacksDebugSetting	The debug setting.
DeploymentStacksDeleteAtManagementGroupHeaders	Defines headers for DeploymentStacks_deleteAtManagementGroup operation.
DeploymentStacksDeleteAtManagementGroupOptionalParams	Optional parameters.
DeploymentStacksDeleteAtResourceGroupHeaders	Defines headers for DeploymentStacks_deleteAtResourceGroup operation.
DeploymentStacksDeleteAtResourceGroupOptionalParams	Optional parameters.
DeploymentStacksDeleteAtSubscriptionHeaders	Defines headers for DeploymentStacks_deleteAtSubscription operation.
DeploymentStacksDeleteAtSubscriptionOptionalParams	Optional parameters.
DeploymentStacksError	Deployment Stacks error response.
DeploymentStacksExportTemplateAtManagementGroupOptionalParams	Optional parameters.
DeploymentStacksExportTemplateAtResourceGroupOptionalParams	Optional parameters.
DeploymentStacksExportTemplateAtSubscriptionOptionalParams	Optional parameters.
DeploymentStacksGetAtManagementGroupOptionalParams	Optional parameters.
DeploymentStacksGetAtResourceGroupOptionalParams	Optional parameters.
DeploymentStacksGetAtSubscriptionOptionalParams	Optional parameters.
DeploymentStacksListAtManagementGroupNextOptionalParams	Optional parameters.
DeploymentStacksListAtManagementGroupOptionalParams	Optional parameters.
DeploymentStacksListAtResourceGroupNextOptionalParams	Optional parameters.
DeploymentStacksListAtResourceGroupOptionalParams	Optional parameters.
DeploymentStacksListAtSubscriptionNextOptionalParams	Optional parameters.
DeploymentStacksListAtSubscriptionOptionalParams	Optional parameters.
DeploymentStacksParametersLink	Entity representing the reference to the deployment parameters.
DeploymentStacksTemplateLink	Entity representing the reference to the template.
DeploymentStacksValidateStackAtManagementGroupHeaders	Defines headers for DeploymentStacks_validateStackAtManagementGroup operation.
DeploymentStacksValidateStackAtManagementGroupOptionalParams	Optional parameters.
DeploymentStacksValidateStackAtResourceGroupHeaders	Defines headers for DeploymentStacks_validateStackAtResourceGroup operation.
DeploymentStacksValidateStackAtResourceGroupOptionalParams	Optional parameters.
DeploymentStacksValidateStackAtSubscriptionHeaders	Defines headers for DeploymentStacks_validateStackAtSubscription operation.
DeploymentStacksValidateStackAtSubscriptionOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
KeyVaultParameterReference	Azure Key Vault parameter reference.
KeyVaultReference	Azure Key Vault reference.
ManagedResourceReference	The managed resource model.
ResourceReference	The resourceId model.
ResourceReferenceExtended	The resourceId extended model. This is used to document failed resources with a resourceId and a corresponding error.
SystemData	Metadata pertaining to creation and last modification of the resource.

Type Aliases

CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DenySettingsMode	Defines values for DenySettingsMode. 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	Defines values for DenyStatusMode. 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.
DeploymentStackProvisioningState	Defines values for DeploymentStackProvisioningState. KnownDeploymentStackProvisioningState can be used interchangeably with DeploymentStackProvisioningState, this enum contains the known values that the service supports. Known values supported by the service creating validating waiting deploying canceling updatingDenyAssignments deletingResources succeeded failed canceled deleting
DeploymentStacksCreateOrUpdateAtManagementGroupResponse	Contains response data for the createOrUpdateAtManagementGroup operation.
DeploymentStacksCreateOrUpdateAtResourceGroupResponse	Contains response data for the createOrUpdateAtResourceGroup operation.
DeploymentStacksCreateOrUpdateAtSubscriptionResponse	Contains response data for the createOrUpdateAtSubscription operation.
DeploymentStacksDeleteDetachEnum	Defines values for DeploymentStacksDeleteDetachEnum. KnownDeploymentStacksDeleteDetachEnum can be used interchangeably with DeploymentStacksDeleteDetachEnum, this enum contains the known values that the service supports. Known values supported by the service delete detach
DeploymentStacksExportTemplateAtManagementGroupResponse	Contains response data for the exportTemplateAtManagementGroup operation.
DeploymentStacksExportTemplateAtResourceGroupResponse	Contains response data for the exportTemplateAtResourceGroup operation.
DeploymentStacksExportTemplateAtSubscriptionResponse	Contains response data for the exportTemplateAtSubscription operation.
DeploymentStacksGetAtManagementGroupResponse	Contains response data for the getAtManagementGroup operation.
DeploymentStacksGetAtResourceGroupResponse	Contains response data for the getAtResourceGroup operation.
DeploymentStacksGetAtSubscriptionResponse	Contains response data for the getAtSubscription operation.
DeploymentStacksListAtManagementGroupNextResponse	Contains response data for the listAtManagementGroupNext operation.
DeploymentStacksListAtManagementGroupResponse	Contains response data for the listAtManagementGroup operation.
DeploymentStacksListAtResourceGroupNextResponse	Contains response data for the listAtResourceGroupNext operation.
DeploymentStacksListAtResourceGroupResponse	Contains response data for the listAtResourceGroup operation.
DeploymentStacksListAtSubscriptionNextResponse	Contains response data for the listAtSubscriptionNext operation.
DeploymentStacksListAtSubscriptionResponse	Contains response data for the listAtSubscription operation.
DeploymentStacksValidateStackAtManagementGroupResponse	Contains response data for the validateStackAtManagementGroup operation.
DeploymentStacksValidateStackAtResourceGroupResponse	Contains response data for the validateStackAtResourceGroup operation.
DeploymentStacksValidateStackAtSubscriptionResponse	Contains response data for the validateStackAtSubscription operation.
ResourceStatusMode	Defines values for ResourceStatusMode. 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.
UnmanageActionManagementGroupMode	Defines values for UnmanageActionManagementGroupMode. KnownUnmanageActionManagementGroupMode can be used interchangeably with UnmanageActionManagementGroupMode, this enum contains the known values that the service supports. Known values supported by the service delete detach
UnmanageActionResourceGroupMode	Defines values for UnmanageActionResourceGroupMode. KnownUnmanageActionResourceGroupMode can be used interchangeably with UnmanageActionResourceGroupMode, this enum contains the known values that the service supports. Known values supported by the service delete detach
UnmanageActionResourceMode	Defines values for UnmanageActionResourceMode. KnownUnmanageActionResourceMode can be used interchangeably with UnmanageActionResourceMode, this enum contains the known values that the service supports. Known values supported by the service delete detach

Enums

KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDenySettingsMode	Known values of DenySettingsMode that the service accepts.
KnownDenyStatusMode	Known values of DenyStatusMode that the service accepts.
KnownDeploymentStackProvisioningState	Known values of DeploymentStackProvisioningState that the service accepts.
KnownDeploymentStacksDeleteDetachEnum	Known values of DeploymentStacksDeleteDetachEnum that the service accepts.
KnownResourceStatusMode	Known values of ResourceStatusMode that the service accepts.
KnownUnmanageActionManagementGroupMode	Known values of UnmanageActionManagementGroupMode that the service accepts.
KnownUnmanageActionResourceGroupMode	Known values of UnmanageActionResourceGroupMode that the service accepts.
KnownUnmanageActionResourceMode	Known values of UnmanageActionResourceMode that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.