DeploymentsOperations Class

DeploymentsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
DeploymentsOperations

Constructor

DeploymentsOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

Create a new Deployment or update an exiting Deployment.

begin_delete

Operation to delete a Deployment.

begin_restart

Restart the deployment.

begin_start

Start the deployment.

begin_stop

Stop the deployment.

begin_update

Operation to update an exiting Deployment.

get

Get a Deployment and its properties.

get_log_file_url

Get deployment log file URL.

list

Handles requests to list all resources in an App.

list_for_cluster

List deployments for a certain service.

begin_create_or_update

Create a new Deployment or update an exiting Deployment.

async begin_create_or_update(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, deployment_resource: azure.mgmt.appplatform.v2020_07_01.models._models_py3.DeploymentResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2020_07_01.models._models_py3.DeploymentResource]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

deployment_resource
DeploymentResource
Required

Parameters for the create or update operation.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either DeploymentResource or the result of cls(response)

Return type

Exceptions

begin_delete

Operation to delete a Deployment.

async begin_delete(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_restart

Restart the deployment.

async begin_restart(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_start

Start the deployment.

async begin_start(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_stop

Stop the deployment.

async begin_stop(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_update

Operation to update an exiting Deployment.

async begin_update(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, deployment_resource: azure.mgmt.appplatform.v2020_07_01.models._models_py3.DeploymentResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2020_07_01.models._models_py3.DeploymentResource]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

deployment_resource
DeploymentResource
Required

Parameters for the update operation.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either DeploymentResource or the result of cls(response)

Return type

Exceptions

get

Get a Deployment and its properties.

async get(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2020_07_01.models._models_py3.DeploymentResource

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

cls
callable

A custom type or function that will be passed the direct response

Returns

DeploymentResource, or the result of cls(response)

Return type

Exceptions

get_log_file_url

Get deployment log file URL.

async get_log_file_url(resource_group_name: str, service_name: str, app_name: str, deployment_name: str, **kwargs: Any) -> Optional[azure.mgmt.appplatform.v2020_07_01.models._models_py3.LogFileUrlResponse]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

deployment_name
str
Required

The name of the Deployment resource.

cls
callable

A custom type or function that will be passed the direct response

Returns

LogFileUrlResponse, or the result of cls(response)

Return type

Exceptions

list

Handles requests to list all resources in an App.

list(resource_group_name: str, service_name: str, app_name: str, version: Optional[List[str]] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2020_07_01.models._models_py3.DeploymentResourceCollection]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

app_name
str
Required

The name of the App resource.

version
list[str]
Required

Version of the deployments to be listed. Default value is None.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DeploymentResourceCollection or the result of cls(response)

Return type

Exceptions

list_for_cluster

List deployments for a certain service.

list_for_cluster(resource_group_name: str, service_name: str, version: Optional[List[str]] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2020_07_01.models._models_py3.DeploymentResourceCollection]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

version
list[str]
Required

Version of the deployments to be listed. Default value is None.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DeploymentResourceCollection or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.appplatform.v2020_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\appplatform\\v2020_07_01\\models\\__init__.py'>