azure.mgmt.cognitiveservices.models module — Azure SDK for Python 2.0.0 documentation

class azure.mgmt.cognitiveservices.models.Account(*, kind: Optional[str] = None, sku: Optional[_models.Sku] = None, identity: Optional[_models.Identity] = None, tags: Optional[Dict[str,str]] = None, location: Optional[str] = None, properties: Optional[_models.AccountProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.AzureEntityResource

Cognitive Services account is an Azure resource representing the provisioned account, it’s type, location and SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “
etag (str) – Resource Etag.
kind (str) – The Kind of the resource.
sku (Sku) – The resource model definition representing SKU.
identity (Identity) – Identity for the resource.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives.
properties (AccountProperties) – Properties of Cognitive Services account.

Keyword Arguments

kind (str) – The Kind of the resource.
sku (Sku) – The resource model definition representing SKU.
identity (Identity) – Identity for the resource.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives.
properties (AccountProperties) – Properties of Cognitive Services account.

class azure.mgmt.cognitiveservices.models.AccountListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The list of cognitive services accounts operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

next_link (str) – The link used to get the next page of accounts.
value (list[Account]) – Gets the list of Cognitive Services accounts and their properties.

Keyword Arguments

next_link (str) – The link used to get the next page of accounts.

class azure.mgmt.cognitiveservices.models.AccountModel(*, format: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, base_model: Optional[_models.DeploymentModel] = None, max_capacity: Optional[int] = None, capabilities: Optional[Dict[str,str]] = None, finetune_capabilities: Optional[Dict[str,str]] = None, deprecation: Optional[_models.ModelDeprecationInfo] = None, lifecycle_status: Optional[Union[str,_models.ModelLifecycleStatus]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.DeploymentModel

Cognitive Services account Model.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

format (str) – Deployment model format.
name (str) – Deployment model name.
version (str) – Deployment model version.
call_rate_limit (CallRateLimit) – The call rate limit Cognitive Services account.
base_model (DeploymentModel) – Base Model Identifier.
max_capacity (int) – The max capacity.
capabilities (dict[str, str]) – The capabilities.
finetune_capabilities (dict[str, str]) – The capabilities for finetune models.
deprecation (ModelDeprecationInfo) – Cognitive Services account ModelDeprecationInfo.
lifecycle_status (str or ModelLifecycleStatus) – Model lifecycle status. Known values are: “GenerallyAvailable” and “Preview”.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

format (str) – Deployment model format.
name (str) – Deployment model name.
version (str) – Deployment model version.
base_model (DeploymentModel) – Base Model Identifier.
max_capacity (int) – The max capacity.
capabilities (dict[str, str]) – The capabilities.
finetune_capabilities (dict[str, str]) – The capabilities for finetune models.
deprecation (ModelDeprecationInfo) – Cognitive Services account ModelDeprecationInfo.
lifecycle_status (str or ModelLifecycleStatus) – Model lifecycle status. Known values are: “GenerallyAvailable” and “Preview”.

class azure.mgmt.cognitiveservices.models.AccountModelListResult(*, next_link: Optional[str] = None, value: Optional[List[_models.AccountModel]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The list of cognitive services accounts operation response.

Variables

next_link (str) – The link used to get the next page of Model.
value (list[AccountModel]) – Gets the list of Cognitive Services accounts Model and their properties.

Keyword Arguments

next_link (str) – The link used to get the next page of Model.
value (list[AccountModel]) – Gets the list of Cognitive Services accounts Model and their properties.

class azure.mgmt.cognitiveservices.models.AccountProperties(*, migration_token: Optional[str] = None, custom_sub_domain_name: Optional[str] = None, network_acls: Optional[_models.NetworkRuleSet] = None, encryption: Optional[_models.Encryption] = None, user_owned_storage: Optional[List[_models.UserOwnedStorage]] = None, public_network_access: Optional[Union[str,_models.PublicNetworkAccess]] = None, api_properties: Optional[_models.ApiProperties] = None, dynamic_throttling_enabled: Optional[bool] = None, restrict_outbound_network_access: Optional[bool] = None, allowed_fqdn_list: Optional[List[str]] = None, disable_local_auth: Optional[bool] = None, restore: Optional[bool] = None, locations: Optional[_models.MultiRegionSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties of Cognitive Services account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str or ProvisioningState) – Gets the status of the cognitive services account at the time the operation was called. Known values are: “Accepted”, “Creating”, “Deleting”, “Moving”, “Failed”, “Succeeded”, and “ResolvingDNS”.
endpoint (str) – Endpoint of the created account.
internal_id (str) – The internal identifier (deprecated, do not use this property).
capabilities (list[SkuCapability]) – Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only.
is_migrated (bool) – If the resource is migrated from an existing key.
migration_token (str) – Resource migration token.
sku_change_info (SkuChangeInfo) – Sku change info of account.
custom_sub_domain_name (str) – Optional subdomain name used for token-based authentication.
network_acls (NetworkRuleSet) – A collection of rules governing the accessibility from specific network locations.
encryption (Encryption) – The encryption properties for this resource.
user_owned_storage (list[UserOwnedStorage]) – The storage accounts for this resource.
private_endpoint_connections (list[PrivateEndpointConnection]) – The private endpoint connection associated with the Cognitive Services account.
public_network_access (str or PublicNetworkAccess) – Whether or not public endpoint access is allowed for this account. Known values are: “Enabled” and “Disabled”.
api_properties (ApiProperties) – The api properties for special APIs.
date_created (str) – Gets the date of cognitive services account creation.
call_rate_limit (CallRateLimit) – The call rate limit Cognitive Services account.
dynamic_throttling_enabled (bool) – The flag to enable dynamic throttling.
quota_limit (QuotaLimit) –
restrict_outbound_network_access (bool) –
allowed_fqdn_list (list[str]) –
disable_local_auth (bool) –
endpoints (dict[str, str]) – Dictionary of <string>.
restore (bool) –
deletion_date (str) – The deletion date, only available for deleted account.
scheduled_purge_date (str) – The scheduled purge date, only available for deleted account.
locations (MultiRegionSettings) – The multiregion settings of Cognitive Services account.
commitment_plan_associations (list[CommitmentPlanAssociation]) – The commitment plan associations of Cognitive Services account.

Keyword Arguments

migration_token (str) – Resource migration token.
custom_sub_domain_name (str) – Optional subdomain name used for token-based authentication.
network_acls (NetworkRuleSet) – A collection of rules governing the accessibility from specific network locations.
encryption (Encryption) – The encryption properties for this resource.
user_owned_storage (list[UserOwnedStorage]) – The storage accounts for this resource.
public_network_access (str orPublicNetworkAccess) – Whether or not public endpoint access is allowed for this account. Known values are: “Enabled” and “Disabled”.
api_properties (ApiProperties) – The api properties for special APIs.
dynamic_throttling_enabled (bool) – The flag to enable dynamic throttling.
restrict_outbound_network_access (bool) –
allowed_fqdn_list (list[str]) –
disable_local_auth (bool) –
restore (bool) –
locations (MultiRegionSettings) – The multiregion settings of Cognitive Services account.

class azure.mgmt.cognitiveservices.models.AccountSku(*, resource_type: Optional[str] = None, sku: Optional[_models.Sku] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Cognitive Services resource type and SKU.

Variables

resource_type (str) – Resource Namespace and Type.
sku (Sku) – The SKU of Cognitive Services account.

Keyword Arguments

resource_type (str) – Resource Namespace and Type.
sku (Sku) – The SKU of Cognitive Services account.

class azure.mgmt.cognitiveservices.models.AccountSkuListResult(*, value: Optional[List[_models.AccountSku]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The list of cognitive services accounts operation response.

Variables: value (list[AccountSku]) – Gets the list of Cognitive Services accounts and their properties.
Keyword Arguments: value (list[AccountSku]) – Gets the list of Cognitive Services accounts and their properties.

class azure.mgmt.cognitiveservices.models.ActionType(value)[source]¶

Bases: str, enum.Enum

Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'¶

class azure.mgmt.cognitiveservices.models.ApiKeys(*, key1: Optional[str] = None, key2: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The access keys for the cognitive services account.

Variables

key1 (str) – Gets the value of key 1.
key2 (str) – Gets the value of key 2.

Keyword Arguments

key1 (str) – Gets the value of key 1.
key2 (str) – Gets the value of key 2.

class azure.mgmt.cognitiveservices.models.ApiProperties(*, additional_properties: Optional[Dict[str,collections.abc.MutableMapping[str,Any]]] = None, qna_runtime_endpoint: Optional[str] = None, qna_azure_search_endpoint_key: Optional[str] = None, qna_azure_search_endpoint_id: Optional[str] = None, statistics_enabled: Optional[bool] = None, event_hub_connection_string: Optional[str] = None, storage_account_connection_string: Optional[str] = None, aad_client_id: Optional[str] = None, aad_tenant_id: Optional[str] = None, super_user: Optional[str] = None, website_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The api properties for special APIs.

Variables

additional_properties (dict[str, JSON]) – Unmatched properties from the message are deserialized to this collection.
qna_runtime_endpoint (str) – (QnAMaker Only) The runtime endpoint of QnAMaker.
qna_azure_search_endpoint_key (str) – (QnAMaker Only) The Azure Search endpoint key of QnAMaker.
qna_azure_search_endpoint_id (str) – (QnAMaker Only) The Azure Search endpoint id of QnAMaker.
statistics_enabled (bool) – (Bing Search Only) The flag to enable statistics of Bing Search.
event_hub_connection_string (str) – (Personalization Only) The flag to enable statistics of Bing Search.
storage_account_connection_string (str) – (Personalization Only) The storage account connection string.
aad_client_id (str) – (Metrics Advisor Only) The Azure AD Client Id (Application Id).
aad_tenant_id (str) – (Metrics Advisor Only) The Azure AD Tenant Id.
super_user (str) – (Metrics Advisor Only) The super user of Metrics Advisor.
website_name (str) – (Metrics Advisor Only) The website name of Metrics Advisor.

Keyword Arguments

additional_properties (dict[str, JSON]) – Unmatched properties from the message are deserialized to this collection.
qna_runtime_endpoint (str) – (QnAMaker Only) The runtime endpoint of QnAMaker.
qna_azure_search_endpoint_key (str) – (QnAMaker Only) The Azure Search endpoint key of QnAMaker.
qna_azure_search_endpoint_id (str) – (QnAMaker Only) The Azure Search endpoint id of QnAMaker.
statistics_enabled (bool) – (Bing Search Only) The flag to enable statistics of Bing Search.
event_hub_connection_string (str) – (Personalization Only) The flag to enable statistics of Bing Search.
storage_account_connection_string (str) – (Personalization Only) The storage account connection string.
aad_client_id (str) – (Metrics Advisor Only) The Azure AD Client Id (Application Id).
aad_tenant_id (str) – (Metrics Advisor Only) The Azure AD Tenant Id.
super_user (str) – (Metrics Advisor Only) The super user of Metrics Advisor.
website_name (str) – (Metrics Advisor Only) The website name of Metrics Advisor.

class azure.mgmt.cognitiveservices.models.AzureEntityResource(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.Resource

The resource model definition for an Azure Resource Manager resource with an etag.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “
etag (str) – Resource Etag.

class azure.mgmt.cognitiveservices.models.CallRateLimit(*, count: Optional[float] = None, renewal_period: Optional[float] = None, rules: Optional[List[_models.ThrottlingRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The call rate limit Cognitive Services account.

Variables

count (float) – The count value of Call Rate Limit.
renewal_period (float) – The renewal period in seconds of Call Rate Limit.
rules (list[ThrottlingRule]) –

Keyword Arguments

count (float) – The count value of Call Rate Limit.
renewal_period (float) – The renewal period in seconds of Call Rate Limit.
rules (list[ThrottlingRule]) –

class azure.mgmt.cognitiveservices.models.CheckDomainAvailabilityParameter(*, subdomain_name: str, type: str, kind: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Check Domain availability parameter.

All required parameters must be populated in order to send to Azure.

Variables

subdomain_name (str) – The subdomain name to use. Required.
type (str) – The Type of the resource. Required.
kind (str) – The Kind of the resource.

Keyword Arguments

subdomain_name (str) – The subdomain name to use. Required.
type (str) – The Type of the resource. Required.
kind (str) – The Kind of the resource.

class azure.mgmt.cognitiveservices.models.CheckSkuAvailabilityParameter(*, skus: List[str], kind: str, type: str, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Check SKU availability parameter.

All required parameters must be populated in order to send to Azure.

Variables

skus (list[str]) – The SKU of the resource. Required.
kind (str) – The Kind of the resource. Required.
type (str) – The Type of the resource. Required.

Keyword Arguments

skus (list[str]) – The SKU of the resource. Required.
kind (str) – The Kind of the resource. Required.
type (str) – The Type of the resource. Required.

class azure.mgmt.cognitiveservices.models.CommitmentCost(*, commitment_meter_id: Optional[str] = None, overage_meter_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Cognitive Services account commitment cost.

Variables

commitment_meter_id (str) – Commitment meter Id.
overage_meter_id (str) – Overage meter Id.

Keyword Arguments

commitment_meter_id (str) – Commitment meter Id.
overage_meter_id (str) – Overage meter Id.

class azure.mgmt.cognitiveservices.models.CommitmentPeriod(*, tier: Optional[str] = None, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Cognitive Services account commitment period.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

tier (str) – Commitment period commitment tier.
count (int) – Commitment period commitment count.
quota (CommitmentQuota) – Cognitive Services account commitment quota.
start_date (str) – Commitment period start date.
end_date (str) – Commitment period end date.

Keyword Arguments

tier (str) – Commitment period commitment tier.
count (int) – Commitment period commitment count.

class azure.mgmt.cognitiveservices.models.CommitmentPlan(*, kind: Optional[str] = None, sku: Optional[_models.Sku] = None, tags: Optional[Dict[str,str]] = None, location: Optional[str] = None, properties: Optional[_models.CommitmentPlanProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.ProxyResource

Cognitive Services account commitment plan.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
etag (str) – Resource Etag.
kind (str) – The Kind of the resource.
sku (Sku) – The resource model definition representing SKU.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives.
properties (CommitmentPlanProperties) – Properties of Cognitive Services account commitment plan.

Keyword Arguments

kind (str) – The Kind of the resource.
sku (Sku) – The resource model definition representing SKU.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives.
properties (CommitmentPlanProperties) – Properties of Cognitive Services account commitment plan.

class azure.mgmt.cognitiveservices.models.CommitmentPlanAccountAssociation(*, account_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.ProxyResource

The commitment plan association.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
etag (str) – Resource Etag.
account_id (str) – The Azure resource id of the account.

Keyword Arguments

account_id (str) – The Azure resource id of the account.

class azure.mgmt.cognitiveservices.models.CommitmentPlanAccountAssociationListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The list of cognitive services Commitment Plan Account Association operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

next_link (str) – The link used to get the next page of Commitment Plan Account Association.
value (list[CommitmentPlanAccountAssociation]) – Gets the list of Cognitive Services Commitment Plan Account Association and their properties.

Keyword Arguments

next_link (str) – The link used to get the next page of Commitment Plan Account Association.

class azure.mgmt.cognitiveservices.models.CommitmentPlanAssociation(*, commitment_plan_id: Optional[str] = None, commitment_plan_location: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The commitment plan association.

Variables

commitment_plan_id (str) – The Azure resource id of the commitment plan.
commitment_plan_location (str) – The location of of the commitment plan.

Keyword Arguments

commitment_plan_id (str) – The Azure resource id of the commitment plan.
commitment_plan_location (str) – The location of of the commitment plan.

class azure.mgmt.cognitiveservices.models.CommitmentPlanListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The list of cognitive services accounts operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

next_link (str) – The link used to get the next page of CommitmentPlan.
value (list[CommitmentPlan]) – Gets the list of Cognitive Services accounts CommitmentPlan and their properties.

Keyword Arguments

next_link (str) – The link used to get the next page of CommitmentPlan.

class azure.mgmt.cognitiveservices.models.CommitmentPlanProperties(*, commitment_plan_guid: Optional[str] = None, hosting_model: Optional[Union[str,_models.HostingModel]] = None, plan_type: Optional[str] = None, current: Optional[_models.CommitmentPeriod] = None, auto_renew: Optional[bool] = None, next: Optional[_models.CommitmentPeriod] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties of Cognitive Services account commitment plan.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str orCommitmentPlanProvisioningState) – Gets the status of the resource at the time the operation was called. Known values are: “Accepted”, “Creating”, “Deleting”, “Moving”, “Failed”, “Succeeded”, and “Canceled”.
commitment_plan_guid (str) – Commitment plan guid.
hosting_model (str or HostingModel) – Account hosting model. Known values are: “Web”, “ConnectedContainer”, and “DisconnectedContainer”.
plan_type (str) – Commitment plan type.
current (CommitmentPeriod) – Cognitive Services account commitment period.
auto_renew (bool) – AutoRenew commitment plan.
next (CommitmentPeriod) – Cognitive Services account commitment period.
last (CommitmentPeriod) – Cognitive Services account commitment period.

Keyword Arguments

commitment_plan_guid (str) – Commitment plan guid.
hosting_model (str or HostingModel) – Account hosting model. Known values are: “Web”, “ConnectedContainer”, and “DisconnectedContainer”.
plan_type (str) – Commitment plan type.
current (CommitmentPeriod) – Cognitive Services account commitment period.
auto_renew (bool) – AutoRenew commitment plan.
next (CommitmentPeriod) – Cognitive Services account commitment period.

class azure.mgmt.cognitiveservices.models.CommitmentPlanProvisioningState(value)[source]¶

Bases: str, enum.Enum

Gets the status of the resource at the time the operation was called.

ACCEPTED = 'Accepted'¶

CANCELED = 'Canceled'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

MOVING = 'Moving'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.cognitiveservices.models.CommitmentQuota(*, quantity: Optional[int] = None, unit: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Cognitive Services account commitment quota.

Variables

quantity (int) – Commitment quota quantity.
unit (str) – Commitment quota unit.

Keyword Arguments

quantity (int) – Commitment quota quantity.
unit (str) – Commitment quota unit.

class azure.mgmt.cognitiveservices.models.CommitmentTier(*, kind: Optional[str] = None, sku_name: Optional[str] = None, hosting_model: Optional[Union[str,_models.HostingModel]] = None, plan_type: Optional[str] = None, tier: Optional[str] = None, max_count: Optional[int] = None, quota: Optional[_models.CommitmentQuota] = None, cost: Optional[_models.CommitmentCost] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Cognitive Services account commitment tier.

Variables

kind (str) – The Kind of the resource.
sku_name (str) – The name of the SKU. Ex - P3. It is typically a letter+number code.
hosting_model (str or HostingModel) – Account hosting model. Known values are: “Web”, “ConnectedContainer”, and “DisconnectedContainer”.
plan_type (str) – Commitment plan type.
tier (str) – Commitment period commitment tier.
max_count (int) – Commitment period commitment max count.
quota (CommitmentQuota) – Cognitive Services account commitment quota.
cost (CommitmentCost) – Cognitive Services account commitment cost.

Keyword Arguments

kind (str) – The Kind of the resource.
sku_name (str) – The name of the SKU. Ex - P3. It is typically a letter+number code.
hosting_model (str or HostingModel) – Account hosting model. Known values are: “Web”, “ConnectedContainer”, and “DisconnectedContainer”.
plan_type (str) – Commitment plan type.
tier (str) – Commitment period commitment tier.
max_count (int) – Commitment period commitment max count.
quota (CommitmentQuota) – Cognitive Services account commitment quota.
cost (CommitmentCost) – Cognitive Services account commitment cost.

class azure.mgmt.cognitiveservices.models.CommitmentTierListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The list of cognitive services accounts operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

next_link (str) – The link used to get the next page of CommitmentTier.
value (list[CommitmentTier]) – Gets the list of Cognitive Services accounts CommitmentTier and their properties.

Keyword Arguments

next_link (str) – The link used to get the next page of CommitmentTier.

class azure.mgmt.cognitiveservices.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.cognitiveservices.models.Deployment(*, properties: Optional[_models.DeploymentProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.ProxyResource

Cognitive Services account deployment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
etag (str) – Resource Etag.
properties (DeploymentProperties) – Properties of Cognitive Services account deployment.

Keyword Arguments

properties (DeploymentProperties) – Properties of Cognitive Services account deployment.

class azure.mgmt.cognitiveservices.models.DeploymentListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The list of cognitive services accounts operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

next_link (str) – The link used to get the next page of Deployment.
value (list[Deployment]) – Gets the list of Cognitive Services accounts Deployment and their properties.

Keyword Arguments

next_link (str) – The link used to get the next page of Deployment.

class azure.mgmt.cognitiveservices.models.DeploymentModel(*, format: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties of Cognitive Services account deployment model.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

format (str) – Deployment model format.
name (str) – Deployment model name.
version (str) – Deployment model version.
call_rate_limit (CallRateLimit) – The call rate limit Cognitive Services account.

Keyword Arguments

format (str) – Deployment model format.
name (str) – Deployment model name.
version (str) – Deployment model version.

class azure.mgmt.cognitiveservices.models.DeploymentProperties(*, model: Optional[_models.DeploymentModel] = None, scale_settings: Optional[_models.DeploymentScaleSettings] = None, rai_policy_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties of Cognitive Services account deployment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provisioning_state (str orDeploymentProvisioningState) – Gets the status of the resource at the time the operation was called. Known values are: “Accepted”, “Creating”, “Deleting”, “Moving”, “Failed”, and “Succeeded”.
model (DeploymentModel) – Properties of Cognitive Services account deployment model.
scale_settings (DeploymentScaleSettings) – Properties of Cognitive Services account deployment model.
capabilities (dict[str, str]) – The capabilities.
rai_policy_name (str) – The name of RAI policy.
call_rate_limit (CallRateLimit) – The call rate limit Cognitive Services account.

Keyword Arguments

model (DeploymentModel) – Properties of Cognitive Services account deployment model.
scale_settings (DeploymentScaleSettings) – Properties of Cognitive Services account deployment model.
rai_policy_name (str) – The name of RAI policy.

class azure.mgmt.cognitiveservices.models.DeploymentProvisioningState(value)[source]¶

Bases: str, enum.Enum

Gets the status of the resource at the time the operation was called.

ACCEPTED = 'Accepted'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

MOVING = 'Moving'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.cognitiveservices.models.DeploymentScaleSettings(*, scale_type: Optional[Union[str,_models.DeploymentScaleType]] = None, capacity: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties of Cognitive Services account deployment model.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

scale_type (str or DeploymentScaleType) – Deployment scale type. Known values are: “Standard” and “Manual”.
capacity (int) – Deployment capacity.
active_capacity (int) – Deployment active capacity. This value might be different fromcapacity if customer recently updated capacity.

Keyword Arguments

scale_type (str or DeploymentScaleType) – Deployment scale type. Known values are: “Standard” and “Manual”.
capacity (int) – Deployment capacity.

class azure.mgmt.cognitiveservices.models.DeploymentScaleType(value)[source]¶

Bases: str, enum.Enum

Deployment scale type.

MANUAL = 'Manual'¶

STANDARD = 'Standard'¶

class azure.mgmt.cognitiveservices.models.DomainAvailability(*, is_subdomain_available: Optional[bool] = None, reason: Optional[str] = None, subdomain_name: Optional[str] = None, type: Optional[str] = None, kind: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Domain availability.

Variables

is_subdomain_available (bool) – Indicates the given SKU is available or not.
reason (str) – Reason why the SKU is not available.
subdomain_name (str) – The subdomain name to use.
type (str) – The Type of the resource.
kind (str) – The Kind of the resource.

Keyword Arguments

is_subdomain_available (bool) – Indicates the given SKU is available or not.
reason (str) – Reason why the SKU is not available.
subdomain_name (str) – The subdomain name to use.
type (str) – The Type of the resource.
kind (str) – The Kind of the resource.

class azure.mgmt.cognitiveservices.models.Encryption(*, key_vault_properties: Optional[_models.KeyVaultProperties] = None, key_source: Union[str,_models.KeySource] = 'Microsoft.KeyVault', **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties to configure Encryption.

Variables

key_vault_properties (KeyVaultProperties) – Properties of KeyVault.
key_source (str or KeySource) – Enumerates the possible value of keySource for Encryption. Known values are: “Microsoft.CognitiveServices” and “Microsoft.KeyVault”.

Keyword Arguments

key_vault_properties (KeyVaultProperties) – Properties of KeyVault.
key_source (str or KeySource) – Enumerates the possible value of keySource for Encryption. Known values are: “Microsoft.CognitiveServices” and “Microsoft.KeyVault”.

class azure.mgmt.cognitiveservices.models.ErrorAdditionalInfo(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.cognitiveservices.models.ErrorDetail(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

class azure.mgmt.cognitiveservices.models.ErrorResponse(*, error: Optional[_models.ErrorDetail] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables: error (ErrorDetail) – The error object.
Keyword Arguments: error (ErrorDetail) – The error object.

class azure.mgmt.cognitiveservices.models.HostingModel(value)[source]¶

Bases: str, enum.Enum

Account hosting model.

CONNECTED_CONTAINER = 'ConnectedContainer'¶

DISCONNECTED_CONTAINER = 'DisconnectedContainer'¶

WEB = 'Web'¶

class azure.mgmt.cognitiveservices.models.Identity(*, type: Optional[Union[str,_models.ResourceIdentityType]] = None, user_assigned_identities: Optional[Dict[str,_models.UserAssignedIdentity]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Identity for the resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str or ResourceIdentityType) – The identity type. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.
tenant_id (str) – The tenant ID of resource.
principal_id (str) – The principal ID of resource identity.
user_assigned_identities (dict[str,UserAssignedIdentity]) – The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/

Keyword Arguments

type (str or ResourceIdentityType) – The identity type. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.
user_assigned_identities (dict[str,UserAssignedIdentity]) – The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/

class azure.mgmt.cognitiveservices.models.IpRule(*, value: str, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A rule governing the accessibility from a specific ip address or ip range.

All required parameters must be populated in order to send to Azure.

Variables: value (str) – An IPv4 address range in CIDR notation, such as ‘124.56.78.91’ (simple IP address) or ‘124.56.78.0/24’ (all addresses that start with 124.56.78). Required.
Keyword Arguments: value (str) – An IPv4 address range in CIDR notation, such as ‘124.56.78.91’ (simple IP address) or ‘124.56.78.0/24’ (all addresses that start with 124.56.78). Required.

class azure.mgmt.cognitiveservices.models.KeyName(value)[source]¶

Bases: str, enum.Enum

key name to generate (Key1|Key2).

KEY1 = 'Key1'¶

KEY2 = 'Key2'¶

class azure.mgmt.cognitiveservices.models.KeySource(value)[source]¶

Bases: str, enum.Enum

Enumerates the possible value of keySource for Encryption.

MICROSOFT_COGNITIVE_SERVICES = 'Microsoft.CognitiveServices'¶

MICROSOFT_KEY_VAULT = 'Microsoft.KeyVault'¶

class azure.mgmt.cognitiveservices.models.KeyVaultProperties(*, key_name: Optional[str] = None, key_version: Optional[str] = None, key_vault_uri: Optional[str] = None, identity_client_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties to configure keyVault Properties.

Variables

key_name (str) – Name of the Key from KeyVault.
key_version (str) – Version of the Key from KeyVault.
key_vault_uri (str) – Uri of KeyVault.
identity_client_id (str) –

Keyword Arguments

key_name (str) – Name of the Key from KeyVault.
key_version (str) – Version of the Key from KeyVault.
key_vault_uri (str) – Uri of KeyVault.
identity_client_id (str) –

class azure.mgmt.cognitiveservices.models.MetricName(*, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A metric name.

Variables

value (str) – The name of the metric.
localized_value (str) – The friendly name of the metric.

Keyword Arguments

value (str) – The name of the metric.
localized_value (str) – The friendly name of the metric.

class azure.mgmt.cognitiveservices.models.ModelDeprecationInfo(*, fine_tune: Optional[str] = None, inference: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Cognitive Services account ModelDeprecationInfo.

Variables

fine_tune (str) – The datetime of deprecation of the fineTune Model.
inference (str) – The datetime of deprecation of the inference Model.

Keyword Arguments

fine_tune (str) – The datetime of deprecation of the fineTune Model.
inference (str) – The datetime of deprecation of the inference Model.

class azure.mgmt.cognitiveservices.models.ModelLifecycleStatus(value)[source]¶

Bases: str, enum.Enum

Model lifecycle status.

GENERALLY_AVAILABLE = 'GenerallyAvailable'¶

PREVIEW = 'Preview'¶

class azure.mgmt.cognitiveservices.models.MultiRegionSettings(*, routing_method: Optional[Union[str,_models.RoutingMethods]] = None, regions: Optional[List[_models.RegionSetting]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The multiregion settings Cognitive Services account.

Variables

routing_method (str or RoutingMethods) – Multiregion routing methods. Known values are: “Priority”, “Weighted”, and “Performance”.
regions (list[RegionSetting]) –

Keyword Arguments

routing_method (str or RoutingMethods) – Multiregion routing methods. Known values are: “Priority”, “Weighted”, and “Performance”.
regions (list[RegionSetting]) –

class azure.mgmt.cognitiveservices.models.NetworkRuleAction(value)[source]¶

Bases: str, enum.Enum

The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.

ALLOW = 'Allow'¶

DENY = 'Deny'¶

class azure.mgmt.cognitiveservices.models.NetworkRuleSet(*, default_action: Optional[Union[str,_models.NetworkRuleAction]] = None, ip_rules: Optional[List[_models.IpRule]] = None, virtual_network_rules: Optional[List[_models.VirtualNetworkRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A set of rules governing the network accessibility.

Variables

default_action (str or NetworkRuleAction) – The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. Known values are: “Allow” and “Deny”.
ip_rules (list[IpRule]) – The list of IP address rules.
virtual_network_rules (list[VirtualNetworkRule]) – The list of virtual network rules.

Keyword Arguments

default_action (str or NetworkRuleAction) – The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. Known values are: “Allow” and “Deny”.
ip_rules (list[IpRule]) – The list of IP address rules.
virtual_network_rules (list[VirtualNetworkRule]) – The list of virtual network rules.

class azure.mgmt.cognitiveservices.models.Operation(*, display: Optional[_models.OperationDisplay] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “ “
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

Keyword Arguments

display (OperationDisplay) – Localized display information for this particular operation.

class azure.mgmt.cognitiveservices.models.OperationDisplay(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Localized display information for this particular operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

class azure.mgmt.cognitiveservices.models.OperationListResult(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Operation]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results (if there are any).

class azure.mgmt.cognitiveservices.models.Origin(value)[source]¶

Bases: str, enum.Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system'¶

USER = 'user'¶

USER_SYSTEM = 'user,system'¶

class azure.mgmt.cognitiveservices.models.PatchResourceTags(*, tags: Optional[Dict[str,str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The object being used to update tags of a resource, in general used for PATCH operations.

Variables: tags (dict[str, str]) – Resource tags.
Keyword Arguments: tags (dict[str, str]) – Resource tags.

class azure.mgmt.cognitiveservices.models.PatchResourceTagsAndSku(*, tags: Optional[Dict[str,str]] = None, sku: Optional[_models.Sku] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.PatchResourceTags

The object being used to update tags and sku of a resource, in general used for PATCH operations.

Variables

tags (dict[str, str]) – Resource tags.
sku (Sku) – The resource model definition representing SKU.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
sku (Sku) – The resource model definition representing SKU.

class azure.mgmt.cognitiveservices.models.PrivateEndpoint(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The Private Endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.cognitiveservices.models.PrivateEndpointConnection(*, properties: Optional[_models.PrivateEndpointConnectionProperties] = None, location: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.AzureEntityResource

The Private Endpoint Connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “
etag (str) – Resource Etag.
properties (PrivateEndpointConnectionProperties) – Resource properties.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
location (str) – The location of the private endpoint connection.

Keyword Arguments

class azure.mgmt.cognitiveservices.models.PrivateEndpointConnectionListResult(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A list of private endpoint connections.

Variables: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
Keyword Arguments: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

class azure.mgmt.cognitiveservices.models.PrivateEndpointConnectionProperties(*, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState, private_endpoint: Optional[_models.PrivateEndpoint] = None, group_ids: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties of the PrivateEndpointConnectProperties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider. Required.
provisioning_state (str orPrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.
group_ids (list[str]) – The private link resource group ids.

Keyword Arguments

private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider. Required.
group_ids (list[str]) – The private link resource group ids.

class azure.mgmt.cognitiveservices.models.PrivateEndpointConnectionProvisioningState(value)[source]¶

Bases: str, enum.Enum

The current provisioning state.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.cognitiveservices.models.PrivateEndpointServiceConnectionStatus(value)[source]¶

Bases: str, enum.Enum

The private endpoint connection status.

APPROVED = 'Approved'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.cognitiveservices.models.PrivateLinkResource(*, properties: Optional[_models.PrivateLinkResourceProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.Resource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “
properties (PrivateLinkResourceProperties) – Resource properties.

Keyword Arguments

properties (PrivateLinkResourceProperties) – Resource properties.

class azure.mgmt.cognitiveservices.models.PrivateLinkResourceListResult(*, value: Optional[List[_models.PrivateLinkResource]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A list of private link resources.

Variables: value (list[PrivateLinkResource]) – Array of private link resources.
Keyword Arguments: value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.cognitiveservices.models.PrivateLinkResourceProperties(*, required_zone_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Properties of a private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.
display_name (str) – The private link resource display name.

Keyword Arguments

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.cognitiveservices.models.PrivateLinkServiceConnectionState(*, status: Optional[Union[str,_models.PrivateEndpointServiceConnectionStatus]] = None, description: Optional[str] = None, actions_required: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A collection of information about the state of the connection between service consumer and provider.

Variables

status (str orPrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

Keyword Arguments

status (str orPrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

class azure.mgmt.cognitiveservices.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

Gets the status of the cognitive services account at the time the operation was called.

ACCEPTED = 'Accepted'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

MOVING = 'Moving'¶

RESOLVING_DNS = 'ResolvingDNS'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.cognitiveservices.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices.models._models_py3.Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “

class azure.mgmt.cognitiveservices.models.PublicNetworkAccess(value)[source]¶

Bases: str, enum.Enum

Whether or not public endpoint access is allowed for this account.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.cognitiveservices.models.QuotaLimit(*, count: Optional[float] = None, renewal_period: Optional[float] = None, rules: Optional[List[_models.ThrottlingRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

QuotaLimit.

Variables
Keyword Arguments

class azure.mgmt.cognitiveservices.models.QuotaUsageStatus(value)[source]¶

Bases: str, enum.Enum

Cognitive Services account quota usage status.

BLOCKED = 'Blocked'¶

INCLUDED = 'Included'¶

IN_OVERAGE = 'InOverage'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.cognitiveservices.models.RegenerateKeyParameters(*, key_name: Union[str,_models.KeyName], **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Regenerate key parameters.

All required parameters must be populated in order to send to Azure.

Variables: key_name (str or KeyName) – key name to generate (Key1|Key2). Required. Known values are: “Key1” and “Key2”.
Keyword Arguments: key_name (str or KeyName) – key name to generate (Key1|Key2). Required. Known values are: “Key1” and “Key2”.

class azure.mgmt.cognitiveservices.models.RegionSetting(*, name: Optional[str] = None, value: Optional[float] = None, customsubdomain: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The call rate limit Cognitive Services account.

Variables

name (str) – Name of the region.
value (float) – A value for priority or weighted routing methods.
customsubdomain (str) – Maps the region to the regional custom subdomain.

Keyword Arguments

name (str) – Name of the region.
value (float) – A value for priority or weighted routing methods.
customsubdomain (str) – Maps the region to the regional custom subdomain.

class azure.mgmt.cognitiveservices.models.RequestMatchPattern(*, path: Optional[str] = None, method: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

RequestMatchPattern.

Variables

path (str) –
method (str) –

Keyword Arguments

path (str) –
method (str) –

class azure.mgmt.cognitiveservices.models.Resource(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “ or “

class azure.mgmt.cognitiveservices.models.ResourceIdentityType(value)[source]¶

Bases: str, enum.Enum

The identity type.

NONE = 'None'¶

SYSTEM_ASSIGNED = 'SystemAssigned'¶

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

class azure.mgmt.cognitiveservices.models.ResourceSku(*, resource_type: Optional[str] = None, name: Optional[str] = None, tier: Optional[str] = None, kind: Optional[str] = None, locations: Optional[List[str]] = None, restrictions: Optional[List[_models.ResourceSkuRestrictions]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Describes an available Cognitive Services SKU.

Variables

resource_type (str) – The type of resource the SKU applies to.
name (str) – The name of SKU.
tier (str) – Specifies the tier of Cognitive Services account.
kind (str) – The Kind of resources that are supported in this SKU.
locations (list[str]) – The set of locations that the SKU is available.
restrictions (list[ResourceSkuRestrictions]) – The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

Keyword Arguments

resource_type (str) – The type of resource the SKU applies to.
name (str) – The name of SKU.
tier (str) – Specifies the tier of Cognitive Services account.
kind (str) – The Kind of resources that are supported in this SKU.
locations (list[str]) – The set of locations that the SKU is available.
restrictions (list[ResourceSkuRestrictions]) – The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

class azure.mgmt.cognitiveservices.models.ResourceSkuListResult(*, value: List[_models.ResourceSku], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The Get Skus operation response.

All required parameters must be populated in order to send to Azure.

Variables

value (list[ResourceSku]) – The list of skus available for the subscription. Required.
next_link (str) – The uri to fetch the next page of Skus.

Keyword Arguments

value (list[ResourceSku]) – The list of skus available for the subscription. Required.
next_link (str) – The uri to fetch the next page of Skus.

class azure.mgmt.cognitiveservices.models.ResourceSkuRestrictionInfo(*, locations: Optional[List[str]] = None, zones: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

ResourceSkuRestrictionInfo.

Variables

locations (list[str]) – Locations where the SKU is restricted.
zones (list[str]) – List of availability zones where the SKU is restricted.

Keyword Arguments

locations (list[str]) – Locations where the SKU is restricted.
zones (list[str]) – List of availability zones where the SKU is restricted.

class azure.mgmt.cognitiveservices.models.ResourceSkuRestrictions(*, type: Optional[Union[str,_models.ResourceSkuRestrictionsType]] = None, values: Optional[List[str]] = None, restriction_info: Optional[_models.ResourceSkuRestrictionInfo] = None, reason_code: Optional[Union[str,_models.ResourceSkuRestrictionsReasonCode]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Describes restrictions of a SKU.

Variables

type (str or ResourceSkuRestrictionsType) – The type of restrictions. Known values are: “Location” and “Zone”.
values (list[str]) – The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
restriction_info (ResourceSkuRestrictionInfo) – The information about the restriction where the SKU cannot be used.
reason_code (str orResourceSkuRestrictionsReasonCode) – The reason for restriction. Known values are: “QuotaId” and “NotAvailableForSubscription”.

Keyword Arguments

type (str or ResourceSkuRestrictionsType) – The type of restrictions. Known values are: “Location” and “Zone”.
values (list[str]) – The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
restriction_info (ResourceSkuRestrictionInfo) – The information about the restriction where the SKU cannot be used.
reason_code (str orResourceSkuRestrictionsReasonCode) – The reason for restriction. Known values are: “QuotaId” and “NotAvailableForSubscription”.

class azure.mgmt.cognitiveservices.models.ResourceSkuRestrictionsReasonCode(value)[source]¶

Bases: str, enum.Enum

The reason for restriction.

NOT_AVAILABLE_FOR_SUBSCRIPTION = 'NotAvailableForSubscription'¶

QUOTA_ID = 'QuotaId'¶

class azure.mgmt.cognitiveservices.models.ResourceSkuRestrictionsType(value)[source]¶

Bases: str, enum.Enum

The type of restrictions.

LOCATION = 'Location'¶

ZONE = 'Zone'¶

class azure.mgmt.cognitiveservices.models.RoutingMethods(value)[source]¶

Bases: str, enum.Enum

Multiregion routing methods.

PERFORMANCE = 'Performance'¶

PRIORITY = 'Priority'¶

WEIGHTED = 'Weighted'¶

class azure.mgmt.cognitiveservices.models.Sku(*, name: str, tier: Optional[Union[str,_models.SkuTier]] = None, size: Optional[str] = None, family: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The resource model definition representing SKU.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – The name of the SKU. Ex - P3. It is typically a letter+number code. Required.
tier (str or SkuTier) – This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. Known values are: “Free”, “Basic”, “Standard”, “Premium”, and “Enterprise”.
size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.
capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Keyword Arguments

name (str) – The name of the SKU. Ex - P3. It is typically a letter+number code. Required.
tier (str or SkuTier) – This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. Known values are: “Free”, “Basic”, “Standard”, “Premium”, and “Enterprise”.
size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.
capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

class azure.mgmt.cognitiveservices.models.SkuAvailability(*, kind: Optional[str] = None, type: Optional[str] = None, sku_name: Optional[str] = None, sku_available: Optional[bool] = None, reason: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

SKU availability.

Variables

kind (str) – The Kind of the resource.
type (str) – The Type of the resource.
sku_name (str) – The SKU of Cognitive Services account.
sku_available (bool) – Indicates the given SKU is available or not.
reason (str) – Reason why the SKU is not available.
message (str) – Additional error message.

Keyword Arguments

kind (str) – The Kind of the resource.
type (str) – The Type of the resource.
sku_name (str) – The SKU of Cognitive Services account.
sku_available (bool) – Indicates the given SKU is available or not.
reason (str) – Reason why the SKU is not available.
message (str) – Additional error message.

class azure.mgmt.cognitiveservices.models.SkuAvailabilityListResult(*, value: Optional[List[_models.SkuAvailability]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Check SKU availability result list.

Variables: value (list[SkuAvailability]) – Check SKU availability result list.
Keyword Arguments: value (list[SkuAvailability]) – Check SKU availability result list.

class azure.mgmt.cognitiveservices.models.SkuCapability(*, name: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

SkuCapability indicates the capability of a certain feature.

Variables

name (str) – The name of the SkuCapability.
value (str) – The value of the SkuCapability.

Keyword Arguments

name (str) – The name of the SkuCapability.
value (str) – The value of the SkuCapability.

class azure.mgmt.cognitiveservices.models.SkuChangeInfo(*, count_of_downgrades: Optional[float] = None, count_of_upgrades_after_downgrades: Optional[float] = None, last_change_date: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Sku change info of account.

Variables

count_of_downgrades (float) – Gets the count of downgrades.
count_of_upgrades_after_downgrades (float) – Gets the count of upgrades after downgrades.
last_change_date (str) – Gets the last change date.

Keyword Arguments

count_of_downgrades (float) – Gets the count of downgrades.
count_of_upgrades_after_downgrades (float) – Gets the count of upgrades after downgrades.
last_change_date (str) – Gets the last change date.

class azure.mgmt.cognitiveservices.models.SkuTier(value)[source]¶

Bases: str, enum.Enum

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

BASIC = 'Basic'¶

ENTERPRISE = 'Enterprise'¶

FREE = 'Free'¶

PREMIUM = 'Premium'¶

STANDARD = 'Standard'¶

class azure.mgmt.cognitiveservices.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str,_models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str,_models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.cognitiveservices.models.ThrottlingRule(*, key: Optional[str] = None, renewal_period: Optional[float] = None, count: Optional[float] = None, min_count: Optional[float] = None, dynamic_throttling_enabled: Optional[bool] = None, match_patterns: Optional[List[_models.RequestMatchPattern]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

ThrottlingRule.

Variables
Keyword Arguments

class azure.mgmt.cognitiveservices.models.UnitType(value)[source]¶

Bases: str, enum.Enum

The unit of the metric.

BYTES = 'Bytes'¶

BYTES_PER_SECOND = 'BytesPerSecond'¶

COUNT = 'Count'¶

COUNT_PER_SECOND = 'CountPerSecond'¶

MILLISECONDS = 'Milliseconds'¶

PERCENT = 'Percent'¶

SECONDS = 'Seconds'¶

class azure.mgmt.cognitiveservices.models.Usage(*, unit: Optional[Union[str,_models.UnitType]] = None, name: Optional[_models.MetricName] = None, quota_period: Optional[str] = None, limit: Optional[float] = None, current_value: Optional[float] = None, next_reset_time: Optional[str] = None, status: Optional[Union[str,_models.QuotaUsageStatus]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The usage data for a usage request.

Variables

unit (str or UnitType) – The unit of the metric. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “Milliseconds”.
name (MetricName) – The name information for the metric.
quota_period (str) – The quota period used to summarize the usage values.
limit (float) – Maximum value for this metric.
current_value (float) – Current value for this metric.
next_reset_time (str) – Next reset time for current quota.
status (str or QuotaUsageStatus) – Cognitive Services account quota usage status. Known values are: “Included”, “Blocked”, “InOverage”, and “Unknown”.

Keyword Arguments

unit (str or UnitType) – The unit of the metric. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “Milliseconds”.
name (MetricName) – The name information for the metric.
quota_period (str) – The quota period used to summarize the usage values.
limit (float) – Maximum value for this metric.
current_value (float) – Current value for this metric.
next_reset_time (str) – Next reset time for current quota.
status (str or QuotaUsageStatus) – Cognitive Services account quota usage status. Known values are: “Included”, “Blocked”, “InOverage”, and “Unknown”.

class azure.mgmt.cognitiveservices.models.UsageListResult(*, value: Optional[List[_models.Usage]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The response to a list usage request.

Variables: value (list[Usage]) – The list of usages for Cognitive Service account.
Keyword Arguments: value (list[Usage]) – The list of usages for Cognitive Service account.

class azure.mgmt.cognitiveservices.models.UserAssignedIdentity(**kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

User-assigned managed identity.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

principal_id (str) – Azure Active Directory principal ID associated with this Identity.
client_id (str) – Client App Id associated with this identity.

class azure.mgmt.cognitiveservices.models.UserOwnedStorage(*, resource_id: Optional[str] = None, identity_client_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

The user owned storage for Cognitive Services account.

Variables

resource_id (str) – Full resource id of a Microsoft.Storage resource.
identity_client_id (str) –

Keyword Arguments

resource_id (str) – Full resource id of a Microsoft.Storage resource.
identity_client_id (str) –

class azure.mgmt.cognitiveservices.models.VirtualNetworkRule(*, id: str, state: Optional[str] = None, ignore_missing_vnet_service_endpoint: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.cognitiveservices._serialization.Model

A rule governing the accessibility from a specific virtual network.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Full resource id of a vnet subnet, such as ‘/subscriptions/subid/resourceGroups/rg1/providers/ Required.
state (str) – Gets the state of virtual network rule.
ignore_missing_vnet_service_endpoint (bool) – Ignore missing vnet service endpoint or not.

Keyword Arguments

id (str) – Full resource id of a vnet subnet, such as ‘/subscriptions/subid/resourceGroups/rg1/providers/ Required.
state (str) – Gets the state of virtual network rule.
ignore_missing_vnet_service_endpoint (bool) – Ignore missing vnet service endpoint or not.

azure.mgmt.cognitiveservices.models module — Azure SDK for Python 2.0.0 documentation

Continue Reading

Kristen Doute Pregnant

Unveiling The Towering Height Of Kareem Abdul-Jabbar: Insights And Revelations

Teresa Muchnik Rosenblum Height, Weight, Net Worth, Age, Birthday, Wikipedia, Who, Nationality, Biog

Unveiling The Enchanting World Of Ozzie Albies' Wife: Discoveries And Insights