Deployments interface

Package:

@azure/arm-appplatform

Interface representing a Deployments.

Methods

beginCreateOrUpdate(string, string, string, string, DeploymentResource, DeploymentsCreateOrUpdateOptionalParams)	Create a new Deployment or update an exiting Deployment.
beginCreateOrUpdateAndWait(string, string, string, string, DeploymentResource, DeploymentsCreateOrUpdateOptionalParams)	Create a new Deployment or update an exiting Deployment.
beginDelete(string, string, string, string, DeploymentsDeleteOptionalParams)	Operation to delete a Deployment.
beginDeleteAndWait(string, string, string, string, DeploymentsDeleteOptionalParams)	Operation to delete a Deployment.
beginDisableRemoteDebugging(string, string, string, string, DeploymentsDisableRemoteDebuggingOptionalParams)	Disable remote debugging.
beginDisableRemoteDebuggingAndWait(string, string, string, string, DeploymentsDisableRemoteDebuggingOptionalParams)	Disable remote debugging.
beginEnableRemoteDebugging(string, string, string, string, DeploymentsEnableRemoteDebuggingOptionalParams)	Enable remote debugging.
beginEnableRemoteDebuggingAndWait(string, string, string, string, DeploymentsEnableRemoteDebuggingOptionalParams)	Enable remote debugging.
beginGenerateHeapDump(string, string, string, string, DiagnosticParameters, DeploymentsGenerateHeapDumpOptionalParams)	Generate Heap Dump
beginGenerateHeapDumpAndWait(string, string, string, string, DiagnosticParameters, DeploymentsGenerateHeapDumpOptionalParams)	Generate Heap Dump
beginGenerateThreadDump(string, string, string, string, DiagnosticParameters, DeploymentsGenerateThreadDumpOptionalParams)	Generate Thread Dump
beginGenerateThreadDumpAndWait(string, string, string, string, DiagnosticParameters, DeploymentsGenerateThreadDumpOptionalParams)	Generate Thread Dump
beginRestart(string, string, string, string, DeploymentsRestartOptionalParams)	Restart the deployment.
beginRestartAndWait(string, string, string, string, DeploymentsRestartOptionalParams)	Restart the deployment.
beginStart(string, string, string, string, DeploymentsStartOptionalParams)	Start the deployment.
beginStartAndWait(string, string, string, string, DeploymentsStartOptionalParams)	Start the deployment.
beginStartJFR(string, string, string, string, DiagnosticParameters, DeploymentsStartJFROptionalParams)	Start JFR
beginStartJFRAndWait(string, string, string, string, DiagnosticParameters, DeploymentsStartJFROptionalParams)	Start JFR
beginStop(string, string, string, string, DeploymentsStopOptionalParams)	Stop the deployment.
beginStopAndWait(string, string, string, string, DeploymentsStopOptionalParams)	Stop the deployment.
beginUpdate(string, string, string, string, DeploymentResource, DeploymentsUpdateOptionalParams)	Operation to update an exiting Deployment.
beginUpdateAndWait(string, string, string, string, DeploymentResource, DeploymentsUpdateOptionalParams)	Operation to update an exiting Deployment.
get(string, string, string, string, DeploymentsGetOptionalParams)	Get a Deployment and its properties.
getLogFileUrl(string, string, string, string, DeploymentsGetLogFileUrlOptionalParams)	Get deployment log file URL
getRemoteDebuggingConfig(string, string, string, string, DeploymentsGetRemoteDebuggingConfigOptionalParams)	Get remote debugging config.
list(string, string, string, DeploymentsListOptionalParams)	Handles requests to list all resources in an App.
listForCluster(string, string, DeploymentsListForClusterOptionalParams)	List deployments for a certain service

Method Details

beginCreateOrUpdate(string, string, string, string, DeploymentResource, DeploymentsCreateOrUpdateOptionalParams)

Create a new Deployment or update an exiting Deployment.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentResource>, DeploymentResource>>

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

options

DeploymentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentResource>, DeploymentResource>>

beginCreateOrUpdateAndWait(string, string, string, string, DeploymentResource, DeploymentsCreateOrUpdateOptionalParams)

Create a new Deployment or update an exiting Deployment.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<DeploymentResource>

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

options

DeploymentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DeploymentResource>

beginDelete(string, string, string, string, DeploymentsDeleteOptionalParams)

Operation to delete a Deployment.

function beginDelete(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options

DeploymentsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, DeploymentsDeleteOptionalParams)

Operation to delete a Deployment.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<void>

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.

options

DeploymentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDisableRemoteDebugging(string, string, string, string, DeploymentsDisableRemoteDebuggingOptionalParams)

Disable remote debugging.

function beginDisableRemoteDebugging(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDisableRemoteDebuggingOptionalParams): Promise<SimplePollerLike<OperationState<RemoteDebugging>, RemoteDebugging>>

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.

options

DeploymentsDisableRemoteDebuggingOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<RemoteDebugging>, RemoteDebugging>>

beginDisableRemoteDebuggingAndWait(string, string, string, string, DeploymentsDisableRemoteDebuggingOptionalParams)

Disable remote debugging.

function beginDisableRemoteDebuggingAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsDisableRemoteDebuggingOptionalParams): Promise<RemoteDebugging>

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.

options

DeploymentsDisableRemoteDebuggingOptionalParams

The options parameters.

Returns

Promise<RemoteDebugging>

beginEnableRemoteDebugging(string, string, string, string, DeploymentsEnableRemoteDebuggingOptionalParams)

Enable remote debugging.

function beginEnableRemoteDebugging(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsEnableRemoteDebuggingOptionalParams): Promise<SimplePollerLike<OperationState<RemoteDebugging>, RemoteDebugging>>

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.

options

DeploymentsEnableRemoteDebuggingOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<RemoteDebugging>, RemoteDebugging>>

beginEnableRemoteDebuggingAndWait(string, string, string, string, DeploymentsEnableRemoteDebuggingOptionalParams)

Enable remote debugging.

function beginEnableRemoteDebuggingAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsEnableRemoteDebuggingOptionalParams): Promise<RemoteDebugging>

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.

options

DeploymentsEnableRemoteDebuggingOptionalParams

The options parameters.

Returns

Promise<RemoteDebugging>

beginGenerateHeapDump(string, string, string, string, DiagnosticParameters, DeploymentsGenerateHeapDumpOptionalParams)

Generate Heap Dump

function beginGenerateHeapDump(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateHeapDumpOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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

options

DeploymentsGenerateHeapDumpOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginGenerateHeapDumpAndWait(string, string, string, string, DiagnosticParameters, DeploymentsGenerateHeapDumpOptionalParams)

Generate Heap Dump

function beginGenerateHeapDumpAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateHeapDumpOptionalParams): Promise<void>

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

options

DeploymentsGenerateHeapDumpOptionalParams

The options parameters.

Returns

Promise<void>

beginGenerateThreadDump(string, string, string, string, DiagnosticParameters, DeploymentsGenerateThreadDumpOptionalParams)

Generate Thread Dump

function beginGenerateThreadDump(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateThreadDumpOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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

options

DeploymentsGenerateThreadDumpOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginGenerateThreadDumpAndWait(string, string, string, string, DiagnosticParameters, DeploymentsGenerateThreadDumpOptionalParams)

Generate Thread Dump

function beginGenerateThreadDumpAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsGenerateThreadDumpOptionalParams): Promise<void>

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

options

DeploymentsGenerateThreadDumpOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, string, string, DeploymentsRestartOptionalParams)

Restart the deployment.

function beginRestart(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options

DeploymentsRestartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, string, string, DeploymentsRestartOptionalParams)

Restart the deployment.

function beginRestartAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsRestartOptionalParams): Promise<void>

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.

options

DeploymentsRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, string, string, DeploymentsStartOptionalParams)

Start the deployment.

function beginStart(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options

DeploymentsStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, string, string, DeploymentsStartOptionalParams)

Start the deployment.

function beginStartAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStartOptionalParams): Promise<void>

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.

options

DeploymentsStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStartJFR(string, string, string, string, DiagnosticParameters, DeploymentsStartJFROptionalParams)

Start JFR

function beginStartJFR(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsStartJFROptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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

options

DeploymentsStartJFROptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartJFRAndWait(string, string, string, string, DiagnosticParameters, DeploymentsStartJFROptionalParams)

Start JFR

function beginStartJFRAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, diagnosticParameters: DiagnosticParameters, options?: DeploymentsStartJFROptionalParams): Promise<void>

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

options

DeploymentsStartJFROptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, string, string, DeploymentsStopOptionalParams)

Stop the deployment.

function beginStop(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options

DeploymentsStopOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, string, string, DeploymentsStopOptionalParams)

Stop the deployment.

function beginStopAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsStopOptionalParams): Promise<void>

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.

options

DeploymentsStopOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, DeploymentResource, DeploymentsUpdateOptionalParams)

Operation to update an exiting Deployment.

function beginUpdate(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentResource>, DeploymentResource>>

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

options

DeploymentsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DeploymentResource>, DeploymentResource>>

beginUpdateAndWait(string, string, string, string, DeploymentResource, DeploymentsUpdateOptionalParams)

Operation to update an exiting Deployment.

function beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, deploymentResource: DeploymentResource, options?: DeploymentsUpdateOptionalParams): Promise<DeploymentResource>

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

options

DeploymentsUpdateOptionalParams

The options parameters.

Returns

Promise<DeploymentResource>

get(string, string, string, string, DeploymentsGetOptionalParams)

Get a Deployment and its properties.

function get(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<DeploymentResource>

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.

options

DeploymentsGetOptionalParams

The options parameters.

Returns

Promise<DeploymentResource>

getLogFileUrl(string, string, string, string, DeploymentsGetLogFileUrlOptionalParams)

Get deployment log file URL

function getLogFileUrl(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsGetLogFileUrlOptionalParams): Promise<LogFileUrlResponse>

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.

options

DeploymentsGetLogFileUrlOptionalParams

The options parameters.

Returns

Promise<LogFileUrlResponse>

getRemoteDebuggingConfig(string, string, string, string, DeploymentsGetRemoteDebuggingConfigOptionalParams)

Get remote debugging config.

function getRemoteDebuggingConfig(resourceGroupName: string, serviceName: string, appName: string, deploymentName: string, options?: DeploymentsGetRemoteDebuggingConfigOptionalParams): Promise<RemoteDebugging>

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.

options

DeploymentsGetRemoteDebuggingConfigOptionalParams

The options parameters.

Returns

Promise<RemoteDebugging>

list(string, string, string, DeploymentsListOptionalParams)

Handles requests to list all resources in an App.

function list(resourceGroupName: string, serviceName: string, appName: string, options?: DeploymentsListOptionalParams): PagedAsyncIterableIterator<DeploymentResource, DeploymentResource[], PageSettings>

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.

options

DeploymentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeploymentResource, DeploymentResource[], PageSettings>

listForCluster(string, string, DeploymentsListForClusterOptionalParams)

List deployments for a certain service

function listForCluster(resourceGroupName: string, serviceName: string, options?: DeploymentsListForClusterOptionalParams): PagedAsyncIterableIterator<DeploymentResource, DeploymentResource[], PageSettings>

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.

options

DeploymentsListForClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeploymentResource, DeploymentResource[], PageSettings>