Share via

DeploymentsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CognitiveServicesManagementClient's

<xref:deployments> attribute.

Inheritance
builtins.object
DeploymentsOperations

Constructor

DeploymentsOperations(*args, **kwargs)

Methods

begin_create_or_update

Update the state of specified deployments associated with the Cognitive Services account.
begin_delete

Deletes the specified deployment associated with the Cognitive Services account.
get

Gets the specified deployments associated with the Cognitive Services account.
list

Gets the deployments associated with the Cognitive Services account.

begin_create_or_update

Update the state of specified deployments associated with the Cognitive Services account.

begin_create_or_update(resource_group_name: str, account_name: str, deployment_name: str, deployment: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Deployment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
deployment_name
Required
str

The name of the deployment associated with the Cognitive Services Account. Required.
deployment
Required
Deployment or IO

The deployment properties. Is either a Deployment type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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 PollingMethod

By default, your polling method will be ARMPolling. 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

Type Description
LROPoller[Deployment]

An instance of LROPoller that returns either Deployment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified deployment associated with the Cognitive Services account.

begin_delete(resource_group_name: str, account_name: str, deployment_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
deployment_name
Required
str

The name of the deployment associated with the Cognitive Services Account. Required.

Keyword-Only Parameters

Name Description
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 PollingMethod

By default, your polling method will be ARMPolling. 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

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

Gets the specified deployments associated with the Cognitive Services account.

get(resource_group_name: str, account_name: str, deployment_name: str, **kwargs: Any) -> Deployment

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
deployment_name
Required
str

The name of the deployment associated with the Cognitive Services Account. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
Deployment

Deployment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets the deployments associated with the Cognitive Services account.

list(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[Deployment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[Deployment]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.cognitiveservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cognitiveservices\\models\\__init__.py'>