Package version:

Interface Deployments

Interface representing a Deployments.

Hierarchy

Deployments

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DeploymentResource>, DeploymentResource>>
Create a new Deployment or update an exiting Deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- deploymentResource: DeploymentResource
  
  Parameters for the create or update operation
- Optional options: DeploymentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DeploymentResource>, DeploymentResource>>
- Defined in operationsInterfaces/deployments.ts:94

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<DeploymentResource>
Create a new Deployment or update an exiting Deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- deploymentResource: DeploymentResource
  
  Parameters for the create or update operation
- Optional options: DeploymentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DeploymentResource>
- Defined in operationsInterfaces/deployments.ts:117

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Operation to delete a Deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/deployments.ts:134

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<void>
Operation to delete a Deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/deployments.ts:150

beginDisableRemoteDebugging

beginDisableRemoteDebugging(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDisableRemoteDebuggingOptionalParams): Promise<PollerLike<PollOperationState<RemoteDebugging>, RemoteDebugging>>
Disable remote debugging.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsDisableRemoteDebuggingOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<RemoteDebugging>, RemoteDebugging>>
- Defined in operationsInterfaces/deployments.ts:340

beginDisableRemoteDebuggingAndWait

beginDisableRemoteDebuggingAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDisableRemoteDebuggingOptionalParams): Promise<RemoteDebugging>
Disable remote debugging.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsDisableRemoteDebuggingOptionalParams
  
  The options parameters.
Returns Promise<RemoteDebugging>
- Defined in operationsInterfaces/deployments.ts:361

beginEnableRemoteDebugging

beginEnableRemoteDebugging(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsEnableRemoteDebuggingOptionalParams): Promise<PollerLike<PollOperationState<RemoteDebugging>, RemoteDebugging>>
Enable remote debugging.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsEnableRemoteDebuggingOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<RemoteDebugging>, RemoteDebugging>>
- Defined in operationsInterfaces/deployments.ts:303

beginEnableRemoteDebuggingAndWait

beginEnableRemoteDebuggingAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsEnableRemoteDebuggingOptionalParams): Promise<RemoteDebugging>
Enable remote debugging.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsEnableRemoteDebuggingOptionalParams
  
  The options parameters.
Returns Promise<RemoteDebugging>
- Defined in operationsInterfaces/deployments.ts:324

beginGenerateHeapDump

beginGenerateHeapDump(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateHeapDumpOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Generate Heap Dump
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- diagnosticParameters: DiagnosticParameters
  
  Parameters for the diagnostic operation
- Optional options: DeploymentsGenerateHeapDumpOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/deployments.ts:410

beginGenerateHeapDumpAndWait

beginGenerateHeapDumpAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateHeapDumpOptionalParams): Promise<void>
Generate Heap Dump
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- diagnosticParameters: DiagnosticParameters
  
  Parameters for the diagnostic operation
- Optional options: DeploymentsGenerateHeapDumpOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/deployments.ts:428

beginGenerateThreadDump

beginGenerateThreadDump(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateThreadDumpOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Generate Thread Dump
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- diagnosticParameters: DiagnosticParameters
  
  Parameters for the diagnostic operation
- Optional options: DeploymentsGenerateThreadDumpOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/deployments.ts:446

beginGenerateThreadDumpAndWait

beginGenerateThreadDumpAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateThreadDumpOptionalParams): Promise<void>
Generate Thread Dump
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- diagnosticParameters: DiagnosticParameters
  
  Parameters for the diagnostic operation
- Optional options: DeploymentsGenerateThreadDumpOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/deployments.ts:464

beginRestart

beginRestart(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Restart the deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/deployments.ts:271

beginRestartAndWait

beginRestartAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsRestartOptionalParams): Promise<void>
Restart the deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsRestartOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/deployments.ts:287

beginStart

beginStart(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Start the deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/deployments.ts:207

beginStartAndWait

beginStartAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStartOptionalParams): Promise<void>
Start the deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsStartOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/deployments.ts:223

beginStartJFR

beginStartJFR(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsStartJFROptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Start JFR
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- diagnosticParameters: DiagnosticParameters
  
  Parameters for the diagnostic operation
- Optional options: DeploymentsStartJFROptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/deployments.ts:482

beginStartJFRAndWait

beginStartJFRAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsStartJFROptionalParams): Promise<void>
Start JFR
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- diagnosticParameters: DiagnosticParameters
  
  Parameters for the diagnostic operation
- Optional options: DeploymentsStartJFROptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/deployments.ts:500

beginStop

beginStop(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Stop the deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsStopOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/deployments.ts:239

beginStopAndWait

beginStopAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStopOptionalParams): Promise<void>
Stop the deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsStopOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/deployments.ts:255

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DeploymentResource>, DeploymentResource>>
Operation to update an exiting Deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- deploymentResource: DeploymentResource
  
  Parameters for the update operation
- Optional options: DeploymentsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DeploymentResource>, DeploymentResource>>
- Defined in operationsInterfaces/deployments.ts:167

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsUpdateOptionalParams): Promise<DeploymentResource>
Operation to update an exiting Deployment.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- deploymentResource: DeploymentResource
  
  Parameters for the update operation
- Optional options: DeploymentsUpdateOptionalParams
  
  The options parameters.
Returns Promise<DeploymentResource>
- Defined in operationsInterfaces/deployments.ts:190

get

get(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<DeploymentResource>
Get a Deployment and its properties.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsGetOptionalParams
  
  The options parameters.
Returns Promise<DeploymentResource>
- Defined in operationsInterfaces/deployments.ts:77

getLogFileUrl

getLogFileUrl(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsGetLogFileUrlOptionalParams): Promise<LogFileUrlResponse>
Get deployment log file URL
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsGetLogFileUrlOptionalParams
  
  The options parameters.
Returns Promise<LogFileUrlResponse>
- Defined in operationsInterfaces/deployments.ts:393

getRemoteDebuggingConfig

getRemoteDebuggingConfig(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsGetRemoteDebuggingConfigOptionalParams): Promise<RemoteDebugging>
Get remote debugging config.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- deploymentName: string
  
  The name of the Deployment resource.
- Optional options: DeploymentsGetRemoteDebuggingConfigOptionalParams
  
  The options parameters.
Returns Promise<RemoteDebugging>
- Defined in operationsInterfaces/deployments.ts:377

list

list(resourceGroupName: string, serviceName: string, appName: string, options?: DeploymentsListOptionalParams): PagedAsyncIterableIterator<DeploymentResource>
Handles requests to list all resources in an App.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- Optional options: DeploymentsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeploymentResource>
- Defined in operationsInterfaces/deployments.ts:50

listForCluster

listForCluster(resourceGroupName: string, serviceName: string, options?: DeploymentsListForClusterOptionalParams): PagedAsyncIterableIterator<DeploymentResource>
List deployments for a certain service
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: DeploymentsListForClusterOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeploymentResource>
- Defined in operationsInterfaces/deployments.ts:63

Interface Deployments

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

deploymentResource: DeploymentResource

Optional options: DeploymentsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DeploymentResource>, DeploymentResource>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

deploymentResource: DeploymentResource

Optional options: DeploymentsCreateOrUpdateOptionalParams

Returns Promise<DeploymentResource>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

Optional options: DeploymentsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

Optional options: DeploymentsDeleteOptionalParams

Returns Promise<void>

beginDisableRemoteDebugging

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

Optional options: DeploymentsDisableRemoteDebuggingOptionalParams

Returns Promise<PollerLike<PollOperationState<RemoteDebugging>, RemoteDebugging>>

beginDisableRemoteDebuggingAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

Optional options: DeploymentsDisableRemoteDebuggingOptionalParams

Returns Promise<RemoteDebugging>

beginEnableRemoteDebugging

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

Optional options: DeploymentsEnableRemoteDebuggingOptionalParams

Returns Promise<PollerLike<PollOperationState<RemoteDebugging>, RemoteDebugging>>

beginEnableRemoteDebuggingAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

Optional options: DeploymentsEnableRemoteDebuggingOptionalParams

Returns Promise<RemoteDebugging>

beginGenerateHeapDump

Parameters

resourceGroupName: string

serviceName: string

appName: string

deploymentName: string

diagnosticParameters: DiagnosticParameters

Optional options: DeploymentsGenerateHeapDumpOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

`Optional` options: DeploymentsCreateOrUpdateOptionalParams

`Optional` options: DeploymentsCreateOrUpdateOptionalParams

`Optional` options: DeploymentsDeleteOptionalParams

`Optional` options: DeploymentsDeleteOptionalParams

`Optional` options: DeploymentsDisableRemoteDebuggingOptionalParams

`Optional` options: DeploymentsDisableRemoteDebuggingOptionalParams

`Optional` options: DeploymentsEnableRemoteDebuggingOptionalParams

`Optional` options: DeploymentsEnableRemoteDebuggingOptionalParams

`Optional` options: DeploymentsGenerateHeapDumpOptionalParams

`Optional` options: DeploymentsGenerateHeapDumpOptionalParams

`Optional` options: DeploymentsGenerateThreadDumpOptionalParams

`Optional` options: DeploymentsGenerateThreadDumpOptionalParams

`Optional` options: DeploymentsRestartOptionalParams

`Optional` options: DeploymentsRestartOptionalParams

`Optional` options: DeploymentsStartOptionalParams

`Optional` options: DeploymentsStartOptionalParams

`Optional` options: DeploymentsStartJFROptionalParams