azure.mgmt.cognitiveservices.operations module

class azure.mgmt.cognitiveservices.operations.AccountsOperations(client, config, serializer, deserializer)[source]

Bases: object

AccountsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2017-04-18”.

create(resource_group_name, account_name, account, custom_headers=None, raw=False, **operation_config)[source]

Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It’s also the resource type for billing.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • account (CognitiveServicesAccount) – The parameters to provide for the created account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CognitiveServicesAccount or ClientRawResponse if raw=true

Return type

CognitiveServicesAccount or ClientRawResponse

Raises

ErrorException

delete(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Cognitive Services account from the resource group. .

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorException

get_properties(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a Cognitive Services account specified by the parameters.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CognitiveServicesAccount or ClientRawResponse if raw=true

Return type

CognitiveServicesAccount or ClientRawResponse

Raises

ErrorException

get_usages(resource_group_name, account_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get usages for the requested Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • filter (str) – An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

UsagesResult or ClientRawResponse if raw=true

Return type

UsagesResult or ClientRawResponse

Raises

ErrorException

list(custom_headers=None, raw=False, **operation_config)[source]

Returns all the resources of a particular type belonging to a subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of CognitiveServicesAccount

Return type

CognitiveServicesAccountPaged[CognitiveServicesAccount]

Raises

ErrorException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Returns all the resources of a particular type belonging to a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of CognitiveServicesAccount

Return type

CognitiveServicesAccountPaged[CognitiveServicesAccount]

Raises

ErrorException

list_keys(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Lists the account keys for the specified Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CognitiveServicesAccountKeys or ClientRawResponse if raw=true

Return type

CognitiveServicesAccountKeys or ClientRawResponse

Raises

ErrorException

list_skus(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

List available SKUs for the requested Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CognitiveServicesAccountEnumerateSkusResult or ClientRawResponse if raw=true

Return type

CognitiveServicesAccountEnumerateSkusResult or ClientRawResponse

Raises

ErrorException

regenerate_key(resource_group_name, account_name, key_name, custom_headers=None, raw=False, **operation_config)[source]

Regenerates the specified account key for the specified Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • key_name (str or KeyName) – key name to generate (Key1|Key2). Possible values include: ‘Key1’, ‘Key2’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CognitiveServicesAccountKeys or ClientRawResponse if raw=true

Return type

CognitiveServicesAccountKeys or ClientRawResponse

Raises

ErrorException

update(resource_group_name, account_name, account, custom_headers=None, raw=False, **operation_config)[source]

Updates a Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • account (CognitiveServicesAccount) – The parameters to provide for the created account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CognitiveServicesAccount or ClientRawResponse if raw=true

Return type

CognitiveServicesAccount or ClientRawResponse

Raises

ErrorException

models = <module 'azure.mgmt.cognitiveservices.models' from '/home/vsts/work/1/s/sdk/cognitiveservices/azure-mgmt-cognitiveservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cognitiveservices/models/__init__.py'>
class azure.mgmt.cognitiveservices.operations.ResourceSkusOperations(client, config, serializer, deserializer)[source]

Bases: object

ResourceSkusOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2017-04-18”.

list(custom_headers=None, raw=False, **operation_config)[source]

Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceSku

Return type

ResourceSkuPaged[ResourceSku]

Raises

CloudError

models = <module 'azure.mgmt.cognitiveservices.models' from '/home/vsts/work/1/s/sdk/cognitiveservices/azure-mgmt-cognitiveservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cognitiveservices/models/__init__.py'>
class azure.mgmt.cognitiveservices.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2017-04-18”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all the available Cognitive Services account operations.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of OperationEntity

Return type

OperationEntityPaged[OperationEntity]

Raises

CloudError

models = <module 'azure.mgmt.cognitiveservices.models' from '/home/vsts/work/1/s/sdk/cognitiveservices/azure-mgmt-cognitiveservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cognitiveservices/models/__init__.py'>
class azure.mgmt.cognitiveservices.operations.PrivateEndpointConnectionsOperations(client, config, serializer, deserializer)[source]

Bases: object

PrivateEndpointConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2017-04-18”.

create_or_update(resource_group_name, account_name, private_endpoint_connection_name, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Update the state of specified private endpoint connection associated with the Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Cognitive Services Account

  • properties (PrivateEndpointConnectionProperties) – Resource properties.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

PrivateEndpointConnection or ClientRawResponse if raw=true

Return type

PrivateEndpointConnection or ClientRawResponse

Raises

CloudError

delete(resource_group_name, account_name, private_endpoint_connection_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified private endpoint connection associated with the Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Cognitive Services Account

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, account_name, private_endpoint_connection_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified private endpoint connection associated with the Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Cognitive Services Account

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

PrivateEndpointConnection or ClientRawResponse if raw=true

Return type

PrivateEndpointConnection or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.cognitiveservices.models' from '/home/vsts/work/1/s/sdk/cognitiveservices/azure-mgmt-cognitiveservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cognitiveservices/models/__init__.py'>
class azure.mgmt.cognitiveservices.operations.PrivateLinkResourcesOperations(client, config, serializer, deserializer)[source]

Bases: object

PrivateLinkResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2017-04-18”.

list(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the private link resources that need to be created for a Cognitive Services account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • account_name (str) – The name of Cognitive Services account.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

PrivateLinkResourceListResult or ClientRawResponse if raw=true

Return type

PrivateLinkResourceListResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.cognitiveservices.models' from '/home/vsts/work/1/s/sdk/cognitiveservices/azure-mgmt-cognitiveservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cognitiveservices/models/__init__.py'>
class azure.mgmt.cognitiveservices.operations.CognitiveServicesManagementClientOperationsMixin[source]

Bases: object

check_domain_availability(subdomain_name, type, custom_headers=None, raw=False, **operation_config)[source]

Check whether a domain is available.

Parameters

  • subdomain_name (str) – The subdomain name to use.

  • type (str) – The Type of the resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CheckDomainAvailabilityResult or ClientRawResponse if raw=true

Return type

CheckDomainAvailabilityResult or ClientRawResponse

Raises

CloudError

check_sku_availability(location, skus, kind, type, custom_headers=None, raw=False, **operation_config)[source]

Check available SKUs.

Parameters

  • location (str) – Resource location.

  • skus (list[str]) – The SKU of the resource.

  • kind (str) – The Kind of the resource.

  • type (str) – The Type of the resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CheckSkuAvailabilityResultList or ClientRawResponse if raw=true

Return type

CheckSkuAvailabilityResultList or ClientRawResponse

Raises

CloudError