AppsOperations Class

AppsOperations 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
AppsOperations

Constructor

AppsOperations(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 App or update an exiting App.

begin_delete

Operation to delete an App.

begin_update

Operation to update an exiting App.

get

Get an App and its properties.

get_resource_upload_url

Get an resource upload URL for an App, which may be artifacts or source archive.

list

Handles requests to list all resources in a Service.

validate_domain

Check the resource name is valid as well as not in use.

begin_create_or_update

Create a new App or update an exiting App.

async begin_create_or_update(resource_group_name: str, service_name: str, app_name: str, app_resource: azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.AppResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.AppResource]

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.

app_resource
AppResource
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 AppResource or the result of cls(response)

Return type

Exceptions

begin_delete

Operation to delete an App.

async begin_delete(resource_group_name: str, service_name: str, app_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.

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 App.

async begin_update(resource_group_name: str, service_name: str, app_name: str, app_resource: azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.AppResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.AppResource]

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.

app_resource
AppResource
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 AppResource or the result of cls(response)

Return type

Exceptions

get

Get an App and its properties.

async get(resource_group_name: str, service_name: str, app_name: str, sync_status: Optional[str] = None, **kwargs: Any) -> azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.AppResource

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.

sync_status
str
Required

Indicates whether sync status. Default value is None.

cls
callable

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

Returns

AppResource, or the result of cls(response)

Return type

Exceptions

get_resource_upload_url

Get an resource upload URL for an App, which may be artifacts or source archive.

async get_resource_upload_url(resource_group_name: str, service_name: str, app_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.ResourceUploadDefinition

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.

cls
callable

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

Returns

ResourceUploadDefinition, or the result of cls(response)

Return type

Exceptions

list

Handles requests to list all resources in a Service.

list(resource_group_name: str, service_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.AppResourceCollection]

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.

cls
callable

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

Returns

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

Return type

Exceptions

validate_domain

Check the resource name is valid as well as not in use.

async validate_domain(resource_group_name: str, service_name: str, app_name: str, validate_payload: azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.CustomDomainValidatePayload, **kwargs: Any) -> azure.mgmt.appplatform.v2021_06_01_preview.models._models_py3.CustomDomainValidateResult

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.

validate_payload
CustomDomainValidatePayload
Required

Custom domain payload to be validated.

cls
callable

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

Returns

CustomDomainValidateResult, or the result of cls(response)

Return type

Exceptions

Attributes

models

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