Class Deployments

Package version

Class representing a Deployments.

Hierarchy

Deployments

Index

Constructors

constructor

Methods

Constructors

constructor

new Deployments(client: DeviceUpdateClientContext): Deployments

- Defined in operations/deployments.ts:36
Initialize a new instance of the class Deployments class.

Parameters
- client: DeviceUpdateClientContext
  
  Reference to the service client
Returns Deployments

Methods

cancelDeployment

cancelDeployment(deploymentId: string, options?: coreHttp.OperationOptions): Promise<DeploymentsCancelDeploymentResponse>

- Defined in operations/deployments.ts:346
Cancels a deployment.

Parameters
- deploymentId: string
  
  Deployment identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DeploymentsCancelDeploymentResponse>

createOrUpdateDeployment

createOrUpdateDeployment(deploymentId: string, deployment: Deployment, options?: coreHttp.OperationOptions): Promise<DeploymentsCreateOrUpdateDeploymentResponse>

- Defined in operations/deployments.ts:206
Creates or updates a deployment.

Parameters
- deploymentId: string
  
  Deployment identifier.
- deployment: Deployment
  
  The deployment properties.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DeploymentsCreateOrUpdateDeploymentResponse>

deleteDeployment

deleteDeployment(deploymentId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in operations/deployments.ts:242
Deletes a deployment.

Parameters
- deploymentId: string
  
  Deployment identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

getDeployment

getDeployment(deploymentId: string, options?: coreHttp.OperationOptions): Promise<DeploymentsGetDeploymentResponse>

- Defined in operations/deployments.ts:171
Gets the properties of a deployment.

Parameters
- deploymentId: string
  
  Deployment identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DeploymentsGetDeploymentResponse>

getDeploymentStatus

getDeploymentStatus(deploymentId: string, options?: coreHttp.OperationOptions): Promise<DeploymentsGetDeploymentStatusResponse>

- Defined in operations/deployments.ts:277
Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.

Parameters
- deploymentId: string
  
  Deployment identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DeploymentsGetDeploymentStatusResponse>

listAllDeployments

listAllDeployments(options?: DeploymentsGetAllDeploymentsOptionalParams): PagedAsyncIterableIterator<Deployment>

- Defined in operations/deployments.ts:50
Gets a list of deployments.

Parameters
- Optional options: DeploymentsGetAllDeploymentsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Deployment>

listDeploymentDevices

listDeploymentDevices(deploymentId: string, options?: DeploymentsGetDeploymentDevicesOptionalParams): PagedAsyncIterableIterator<DeploymentDeviceState>

- Defined in operations/deployments.ts:94
Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.

Parameters
- deploymentId: string
  
  Deployment identifier.
- Optional options: DeploymentsGetDeploymentDevicesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeploymentDeviceState>

retryDeployment

retryDeployment(deploymentId: string, options?: coreHttp.OperationOptions): Promise<DeploymentsRetryDeploymentResponse>

- Defined in operations/deployments.ts:380
Retries a deployment with failed devices.

Parameters
- deploymentId: string
  
  Deployment identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<DeploymentsRetryDeploymentResponse>

Generated using TypeDoc