@azure/arm-resourcesdeployments package

Classes

Interfaces

Alias	The alias type.
AliasPath	The type of the paths for alias.
AliasPathMetadata	model interface AliasPathMetadata
AliasPattern	The type of the pattern for an alias path.
ApiProfile	model interface ApiProfile
BasicDependency	Deployment dependency information.
CloudError	An error response for a resource management request.
DebugSetting	The debug setting.
Dependency	Deployment dependency information.
Deployment	Deployment operation parameters.
DeploymentDiagnosticsDefinition	model interface DeploymentDiagnosticsDefinition
DeploymentExportResult	The deployment export result.
DeploymentExtended	Deployment information.
DeploymentExtensionConfigItem	model interface DeploymentExtensionConfigItem
DeploymentExtensionDefinition	model interface DeploymentExtensionDefinition
DeploymentExternalInput	Deployment external input for parameterization.
DeploymentExternalInputDefinition	Deployment external input definition for parameterization.
DeploymentIdentity	The Managed Identity configuration for a deployment.
DeploymentOperation	Deployment operation information.
DeploymentOperationProperties	Deployment operation properties.
DeploymentOperationsGetAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentOperationsGetAtScopeOptionalParams	Optional parameters.
DeploymentOperationsGetAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentOperationsGetAtTenantScopeOptionalParams	Optional parameters.
DeploymentOperationsGetOptionalParams	Optional parameters.
DeploymentOperationsListAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentOperationsListAtScopeOptionalParams	Optional parameters.
DeploymentOperationsListAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentOperationsListAtTenantScopeOptionalParams	Optional parameters.
DeploymentOperationsListOptionalParams	Optional parameters.
DeploymentOperationsOperations	Interface representing a DeploymentOperations operations.
DeploymentParameter	Deployment parameter for the template.
DeploymentProperties	Deployment properties.
DeploymentPropertiesExtended	Deployment properties with additional details.
DeploymentValidateResult	Information from validate template deployment response.
DeploymentWhatIf	Deployment What-if operation parameters.
DeploymentWhatIfProperties	Deployment What-if properties.
DeploymentWhatIfSettings	Deployment What-If operation settings.
DeploymentsCalculateTemplateHashOptionalParams	Optional parameters.
DeploymentsCancelAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsCancelAtScopeOptionalParams	Optional parameters.
DeploymentsCancelAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsCancelAtTenantScopeOptionalParams	Optional parameters.
DeploymentsCancelOptionalParams	Optional parameters.
DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsCheckExistenceAtScopeOptionalParams	Optional parameters.
DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsCheckExistenceAtTenantScopeOptionalParams	Optional parameters.
DeploymentsCheckExistenceOptionalParams	Optional parameters.
DeploymentsClientOptionalParams	Optional parameters for the client.
DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsCreateOrUpdateAtScopeOptionalParams	Optional parameters.
DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsCreateOrUpdateAtTenantScopeOptionalParams	Optional parameters.
DeploymentsCreateOrUpdateOptionalParams	Optional parameters.
DeploymentsDeleteAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsDeleteAtScopeOptionalParams	Optional parameters.
DeploymentsDeleteAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsDeleteAtTenantScopeOptionalParams	Optional parameters.
DeploymentsDeleteOptionalParams	Optional parameters.
DeploymentsExportTemplateAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsExportTemplateAtScopeOptionalParams	Optional parameters.
DeploymentsExportTemplateAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsExportTemplateAtTenantScopeOptionalParams	Optional parameters.
DeploymentsExportTemplateOptionalParams	Optional parameters.
DeploymentsGetAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsGetAtScopeOptionalParams	Optional parameters.
DeploymentsGetAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsGetAtTenantScopeOptionalParams	Optional parameters.
DeploymentsGetOptionalParams	Optional parameters.
DeploymentsListAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsListAtScopeOptionalParams	Optional parameters.
DeploymentsListAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsListAtTenantScopeOptionalParams	Optional parameters.
DeploymentsListByResourceGroupOptionalParams	Optional parameters.
DeploymentsOperations	Interface representing a Deployments operations.
DeploymentsValidateAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsValidateAtScopeOptionalParams	Optional parameters.
DeploymentsValidateAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsValidateAtTenantScopeOptionalParams	Optional parameters.
DeploymentsValidateOptionalParams	Optional parameters.
DeploymentsWhatIfAtManagementGroupScopeOptionalParams	Optional parameters.
DeploymentsWhatIfAtSubscriptionScopeOptionalParams	Optional parameters.
DeploymentsWhatIfAtTenantScopeOptionalParams	Optional parameters.
DeploymentsWhatIfOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
ExpressionEvaluationOptions	Specifies whether template expressions are evaluated within the scope of the parent template or nested template.
ExtensionResource	The base extension resource.
HttpMessage	HTTP message.
KeyVaultParameterReference	Azure Key Vault parameter reference.
KeyVaultReference	Azure Key Vault reference.
OnErrorDeployment	Deployment on error behavior.
OnErrorDeploymentExtended	Deployment on error behavior with additional details.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ParametersLink	Entity representing the reference to the deployment parameters.
Provider	Resource provider information.
ProviderExtendedLocation	The provider extended location.
ProviderResourceType	Resource type managed by the resource provider.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceReference	The resource Id model.
RestorePollerOptions
ScopedDeployment	Deployment operation parameters.
ScopedDeploymentWhatIf	Deployment What-if operation parameters.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
StatusMessage	Operation status message object.
SystemData	Metadata pertaining to creation and last modification of the resource.
TargetResource	Target resource.
TemplateHashResult	Result of the request to calculate template hash. It contains a string of minified template and its hash.
TemplateLink	Entity representing the reference to the template.
UserAssignedIdentity	User assigned identity properties
WhatIfChange	Information about a single resource change predicted by What-If operation.
WhatIfOperationProperties	Deployment operation properties.
WhatIfOperationResult	Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.
WhatIfPropertyChange	The predicted change to the resource property.
ZoneMapping	model interface ZoneMapping

Type Aliases

AliasPathAttributes	The attributes of the token that the alias path is referring to. KnownAliasPathAttributes can be used interchangeably with AliasPathAttributes, this enum contains the known values that the service supports. Known values supported by the service None: The token that the alias path is referring to has no attributes. Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect.
AliasPathTokenType	The type of the token that the alias path is referring to. KnownAliasPathTokenType can be used interchangeably with AliasPathTokenType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The token type is not specified. Any: The token type can be anything. String: The token type is string. Object: The token type is object. Array: The token type is array. Integer: The token type is integer. Number: The token type is number. Boolean: The token type is boolean.
AliasPatternType	The type of alias pattern
AliasType	The type of the alias.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ChangeType	Type of change that will be made to the resource when the deployment is executed.
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.
DeploymentIdentityType	The identity type. KnownDeploymentIdentityType can be used interchangeably with DeploymentIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: None UserAssigned: UserAssigned
DeploymentMode	The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.
DeploymentsCheckExistenceAtManagementGroupScopeResponse
DeploymentsCheckExistenceAtScopeResponse
DeploymentsCheckExistenceAtSubscriptionScopeResponse
DeploymentsCheckExistenceAtTenantScopeResponse
DeploymentsCheckExistenceResponse
ExpressionEvaluationOptionsScopeType	The scope to be used for evaluation of parameters, variables and functions in a nested template. KnownExpressionEvaluationOptionsScopeType can be used interchangeably with ExpressionEvaluationOptionsScopeType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: NotSpecified Outer: Outer Inner: Inner
ExtensionConfigPropertyType	Type of ExtensionConfigPropertyType
Level	Denotes the additional response level. KnownLevel can be used interchangeably with Level, this enum contains the known values that the service supports. Known values supported by the service Warning: Warning Info: Info Error: Error
OnErrorDeploymentType	The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.
PropertyChangeType	The type of property change.
ProviderAuthorizationConsentState	The provider authorization consent state. KnownProviderAuthorizationConsentState can be used interchangeably with ProviderAuthorizationConsentState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: NotSpecified Required: Required NotRequired: NotRequired Consented: Consented
ProvisioningOperation	The name of the current provisioning operation.
ProvisioningState	Denotes the state of provisioning. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: NotSpecified Accepted: Accepted Running: Running Ready: Ready Creating: Creating Created: Created Deleting: Deleting Deleted: Deleted Canceled: Canceled Failed: Failed Succeeded: Succeeded Updating: Updating
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.
WhatIfResultFormat	The format of the What-If results

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAliasPathAttributes	The attributes of the token that the alias path is referring to.
KnownAliasPathTokenType	The type of the token that the alias path is referring to.
KnownCreatedByType	The kind of entity that created the resource.
KnownDeploymentIdentityType	The identity type.
KnownExpressionEvaluationOptionsScopeType	The scope to be used for evaluation of parameters, variables and functions in a nested template.
KnownExtensionConfigPropertyType	Known values of ExtensionConfigPropertyType that the service accepts.
KnownLevel	Denotes the additional response level.
KnownProviderAuthorizationConsentState	The provider authorization consent state.
KnownProvisioningState	Denotes the state of provisioning.
KnownValidationLevel	The level of validation performed on the deployment.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(DeploymentsClient, 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.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(DeploymentsClient, 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: DeploymentsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: DeploymentsClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-resourcesdeployments package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

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

Parameters

Returns

Variable Details

RestError

Type

Feedback