Share via

AzureDeploymentManager class

  • Reference
Package:
@azure/arm-deploymentmanager
Extends
AzureDeploymentManagerContext

Constructors

AzureDeploymentManager(ServiceClientCredentials | TokenCredential, string, AzureDeploymentManagerOptions)

Initializes a new instance of the AzureDeploymentManager class.

Properties

artifactSources
operations
rollouts
services
serviceTopologies
serviceUnits
steps

Inherited Properties

acceptLanguage
apiVersion
credentials
longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.
subscriptionId

Inherited Methods

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.
restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

Constructor Details

AzureDeploymentManager(ServiceClientCredentials | TokenCredential, string, AzureDeploymentManagerOptions)

Initializes a new instance of the AzureDeploymentManager class.

new AzureDeploymentManager(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: AzureDeploymentManagerOptions)

Parameters

credentials

ServiceClientCredentials | TokenCredential

Credentials needed for the client to connect to Azure. Credentials implementing the TokenCredential interface from the @azure/identity package are recommended. For more information about these credentials, see https://www.npmjs.com/package/@azure/identity. Credentials implementing the ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and @azure/ms-rest-browserauth are also supported.

subscriptionId

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options
AzureDeploymentManagerOptions

The parameter options

Property Details

artifactSources 

artifactSources: ArtifactSources

Property Value

ArtifactSources

operations 

operations: Operations

Property Value

Operations

rollouts 

rollouts: Rollouts

Property Value

Rollouts

services 

services: Services

Property Value

Services

serviceTopologies 

serviceTopologies: ServiceTopologies

Property Value

ServiceTopologies

serviceUnits 

serviceUnits: ServiceUnits

Property Value

ServiceUnits

steps 

steps: Steps

Property Value

Steps

Inherited Property Details

acceptLanguage 

acceptLanguage: string

Property Value

string

Inherited From AzureDeploymentManagerContext.acceptLanguage

apiVersion 

apiVersion?: string

Property Value

string

Inherited From AzureDeploymentManagerContext.apiVersion

credentials 

credentials: ServiceClientCredentials | TokenCredential

Property Value

ServiceClientCredentials | TokenCredential

Inherited From AzureDeploymentManagerContext.credentials

longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.

longRunningOperationRetryTimeout?: number

Property Value

number

Inherited From AzureDeploymentManagerContext.longRunningOperationRetryTimeout

subscriptionId 

subscriptionId: string

Property Value

string

Inherited From AzureDeploymentManagerContext.subscriptionId

Inherited Method Details

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.

function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

request

RequestPrepareOptions | WebResource

The request object

options
RequestOptionsBase

Additional options to be sent while making the request

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

The HttpLongRunningOperationResponse that provides methods for interacting with the LRO.

Inherited From AzureDeploymentManagerContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parameters

lroPollState
@azure/ms-rest-azure-js.LROPollState

Returns

@azure/ms-rest-azure-js.LROPoller

Inherited From AzureDeploymentManagerContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.

function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>

Parameters

request

RequestPrepareOptions | WebResource

The request object

options
RequestOptionsBase

Additional options to be sent while making the request

Returns

Promise<HttpOperationResponse>

The HttpOperationResponse containing the final polling request, response and the responseBody.

Inherited From AzureDeploymentManagerContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.

function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

operationArguments
OperationArguments

The arguments to the operation.

operationSpec
OperationSpec

The specification for the operation.

options
RequestOptionsBase

Additional options to be sent while making the request.

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

The LROPoller object that provides methods for interacting with the LRO.

Inherited From AzureDeploymentManagerContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

callback

ServiceCallback<any>

The callback to call when the response is received.

Returns

Promise<RestResponse>

Inherited From AzureDeploymentManagerContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From AzureDeploymentManagerContext.sendRequest