azure.mgmt.cognitiveservices.models module¶
-
exception
azure.mgmt.cognitiveservices.models.
ErrorException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘Error’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
class
azure.mgmt.cognitiveservices.models.
AzureEntityResource
(**kwargs)[source]¶ Bases:
azure.mgmt.cognitiveservices.models._models_py3.Resource
The resource model definition for a 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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
etag (str) – Resource Etag.
-
class
azure.mgmt.cognitiveservices.models.
CheckDomainAvailabilityParameter
(*, subdomain_name: str, type: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Check Domain availability parameter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.cognitiveservices.models.
CheckDomainAvailabilityResult
(*, is_subdomain_available: bool = None, reason: str = None, subdomain_name: str = None, type: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Check Domain availability result.
-
class
azure.mgmt.cognitiveservices.models.
CheckSkuAvailabilityParameter
(*, skus, kind: str, type: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Check SKU availability parameter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.cognitiveservices.models.
CheckSkuAvailabilityResult
(*, kind: str = None, type: str = None, sku_name: str = None, sku_available: bool = None, reason: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Check SKU availability result.
- Parameters
-
class
azure.mgmt.cognitiveservices.models.
CheckSkuAvailabilityResultList
(*, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Check SKU availability result list.
- Parameters
value (list[CheckSkuAvailabilityResult]) – Check SKU availability result list.
-
class
azure.mgmt.cognitiveservices.models.
CognitiveServicesAccount
(*, kind: str = None, location: str = None, properties=None, sku=None, tags=None, identity=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Cognitive Services Account is an Azure resource representing the provisioned account, its type, location and SKU.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
kind (str) – The Kind of the resource.
location (str) – The location of the resource
properties (CognitiveServicesAccountProperties) – Properties of Cognitive Services account.
sku (Sku) – The SKU of Cognitive Services account.
tags (dict[str, str]) – Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
identity (Identity) – The identity of Cognitive Services account.
-
class
azure.mgmt.cognitiveservices.models.
CognitiveServicesAccountApiProperties
(*, qna_runtime_endpoint: str = None, statistics_enabled: bool = None, event_hub_connection_string: str = None, storage_account_connection_string: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The api properties for special APIs.
- Parameters
qna_runtime_endpoint (str) – (QnAMaker Only) The runtime endpoint 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.
-
class
azure.mgmt.cognitiveservices.models.
CognitiveServicesAccountEnumerateSkusResult
(**kwargs)[source]¶ Bases:
msrest.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
value (list[CognitiveServicesResourceAndSku]) – Gets the list of Cognitive Services accounts and their properties.
-
class
azure.mgmt.cognitiveservices.models.
CognitiveServicesAccountKeys
(*, key1: str = None, key2: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The access keys for the cognitive services account.
-
class
azure.mgmt.cognitiveservices.models.
CognitiveServicesAccountProperties
(*, custom_sub_domain_name: str = None, network_acls=None, encryption=None, user_owned_storage=None, private_endpoint_connections=None, public_network_access=None, api_properties=None, **kwargs)[source]¶ Bases:
msrest.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. Possible values include: ‘Creating’, ‘ResolvingDNS’, ‘Moving’, ‘Deleting’, ‘Succeeded’, ‘Failed’
endpoint (str) – Endpoint of the created account.
internal_id (str) – The internal identifier.
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.
- Parameters
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. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’
api_properties (CognitiveServicesAccountApiProperties) – The api properties for special APIs.
-
class
azure.mgmt.cognitiveservices.models.
CognitiveServicesResourceAndSku
(*, resource_type: str = None, sku=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Cognitive Services resource type and SKU.
-
class
azure.mgmt.cognitiveservices.models.
Encryption
(*, key_vault_properties=None, key_source='Microsoft.KeyVault', **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties to configure Encryption.
- Parameters
key_vault_properties (KeyVaultProperties) – Properties of KeyVault
key_source (str or KeySource) – Enumerates the possible value of keySource for Encryption. Possible values include: ‘Microsoft.CognitiveServices’, ‘Microsoft.KeyVault’. Default value: “Microsoft.KeyVault” .
-
class
azure.mgmt.cognitiveservices.models.
Error
(*, error=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Cognitive Services error object.
- Parameters
error (ErrorBody) – The error body.
-
class
azure.mgmt.cognitiveservices.models.
ErrorBody
(*, code: str, message: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Cognitive Services error body.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.cognitiveservices.models.
Identity
(*, type=None, user_assigned_identities=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Managed service identity.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
type (str or IdentityType) – Type of managed service identity. Possible values include: ‘None’, ‘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/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
- Variables
-
class
azure.mgmt.cognitiveservices.models.
IpRule
(*, value: str, **kwargs)[source]¶ Bases:
msrest.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.
- Parameters
value (str) – Required. 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).
-
class
azure.mgmt.cognitiveservices.models.
KeyVaultProperties
(*, key_name: str = None, key_version: str = None, key_vault_uri: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties to configure keyVault Properties.
-
class
azure.mgmt.cognitiveservices.models.
MetricName
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
A metric name.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.cognitiveservices.models.
NetworkRuleSet
(*, default_action=None, ip_rules=None, virtual_network_rules=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A set of rules governing the network accessibility.
- Parameters
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. Possible values include: ‘Allow’, ‘Deny’
virtual_network_rules (list[VirtualNetworkRule]) – The list of virtual network rules.
-
class
azure.mgmt.cognitiveservices.models.
OperationDisplayInfo
(*, description: str = None, operation: str = None, provider: str = None, resource: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The operation supported by Cognitive Services.
-
class
azure.mgmt.cognitiveservices.models.
OperationEntity
(*, name: str = None, display=None, origin: str = None, properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The operation supported by Cognitive Services.
- Parameters
name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplayInfo) – The operation supported by Cognitive Services.
origin (str) – The origin of the operation.
properties (object) – Additional properties.
-
class
azure.mgmt.cognitiveservices.models.
PrivateEndpoint
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The Private Endpoint resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.cognitiveservices.models.
PrivateEndpointConnection
(*, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.cognitiveservices.models._models_py3.Resource
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- Parameters
properties (PrivateEndpointConnectionProperties) – Resource properties.
-
class
azure.mgmt.cognitiveservices.models.
PrivateEndpointConnectionProperties
(*, private_link_service_connection_state, private_endpoint=None, group_ids=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of the PrivateEndpointConnectProperties.
All required parameters must be populated in order to send to Azure.
- Parameters
private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – Required. A collection of information about the state of the connection between service consumer and provider.
group_ids (list[str]) – The private link resource group ids.
-
class
azure.mgmt.cognitiveservices.models.
PrivateLinkResource
(*, properties=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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- Parameters
properties (PrivateLinkResourceProperties) – Resource properties.
-
class
azure.mgmt.cognitiveservices.models.
PrivateLinkResourceListResult
(*, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A list of private link resources.
- Parameters
value (list[PrivateLinkResource]) – Array of private link resources
-
class
azure.mgmt.cognitiveservices.models.
PrivateLinkResourceProperties
(*, required_zone_names=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of a private link resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.cognitiveservices.models.
PrivateLinkServiceConnectionState
(*, status=None, description: str = None, action_required: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A collection of information about the state of the connection between service consumer and provider.
- Parameters
status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: ‘Pending’, ‘Approved’, ‘Rejected’, ‘Disconnected’
description (str) – The reason for approval/rejection of the connection.
action_required (str) – A message indicating if changes on the service provider require any updates on the consumer.
-
class
azure.mgmt.cognitiveservices.models.
ProxyResource
(**kwargs)[source]¶ Bases:
azure.mgmt.cognitiveservices.models._models_py3.Resource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
-
class
azure.mgmt.cognitiveservices.models.
RegenerateKeyParameters
(*, key_name, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Regenerate key parameters.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.cognitiveservices.models.
Resource
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
-
class
azure.mgmt.cognitiveservices.models.
ResourceSku
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes an available Cognitive Services SKU.
Variables are only populated by the server, and will be ignored when sending a request.
- 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.
-
class
azure.mgmt.cognitiveservices.models.
ResourceSkuRestrictionInfo
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ResourceSkuRestrictionInfo.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.cognitiveservices.models.
ResourceSkuRestrictions
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes restrictions of a SKU.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
type (str or ResourceSkuRestrictionsType) – The type of restrictions. Possible values include: ‘Location’, ‘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 or ResourceSkuRestrictionsReasonCode) – The reason for restriction. Possible values include: ‘QuotaId’, ‘NotAvailableForSubscription’
-
class
azure.mgmt.cognitiveservices.models.
Sku
(*, name: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The SKU of the cognitive services account.
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.
-
class
azure.mgmt.cognitiveservices.models.
SkuCapability
(*, name: str = None, value: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
SkuCapability indicates the capability of a certain feature.
-
class
azure.mgmt.cognitiveservices.models.
TrackedResource
(*, location: str, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.cognitiveservices.models._models_py3.Resource
The resource model definition for a ARM tracked top level resource.
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
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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- Parameters
-
class
azure.mgmt.cognitiveservices.models.
Usage
(*, unit=None, status=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The usage data for a usage request.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
unit (str or UnitType) – The unit of the metric. Possible values include: ‘Count’, ‘Bytes’, ‘Seconds’, ‘Percent’, ‘CountPerSecond’, ‘BytesPerSecond’, ‘Milliseconds’
status (str or QuotaUsageStatus) – Cognitive Services account quota usage status. Possible values include: ‘Included’, ‘Blocked’, ‘InOverage’, ‘Unknown’
- Variables
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.
-
class
azure.mgmt.cognitiveservices.models.
UsagesResult
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The response to a list usage request.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.cognitiveservices.models.
UserAssignedIdentity
(*, principal_id: str = None, client_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
User-assigned managed identity.
-
class
azure.mgmt.cognitiveservices.models.
UserOwnedStorage
(*, resource_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The user owned storage for Cognitive Services account.
- Parameters
resource_id (str) – Full resource id of a Microsoft.Storage resource.
-
class
azure.mgmt.cognitiveservices.models.
VirtualNetworkRule
(*, id: str, state: str = None, ignore_missing_vnet_service_endpoint: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A rule governing the accessibility from a specific virtual network.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – Required. Full resource id of a vnet subnet, such as ‘/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1’.
state (str) – Gets the state of virtual network rule.
ignore_missing_vnet_service_endpoint (bool) – Ignore missing vnet service endpoint or not.
-
class
azure.mgmt.cognitiveservices.models.
CognitiveServicesAccountPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
CognitiveServicesAccount
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.cognitiveservices.models.
ResourceSkuPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ResourceSku
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.cognitiveservices.models.
OperationEntityPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
OperationEntity
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.cognitiveservices.models.
SkuTier
[source]¶ -
An enumeration.
-
free
= 'Free'¶
-
standard
= 'Standard'¶
-
-
class
azure.mgmt.cognitiveservices.models.
ProvisioningState
[source]¶ -
An enumeration.
-
creating
= 'Creating'¶
-
deleting
= 'Deleting'¶
-
failed
= 'Failed'¶
-
moving
= 'Moving'¶
-
resolving_dns
= 'ResolvingDNS'¶
-
succeeded
= 'Succeeded'¶
-
-
class
azure.mgmt.cognitiveservices.models.
NetworkRuleAction
[source]¶ -
An enumeration.
-
allow
= 'Allow'¶
-
deny
= 'Deny'¶
-
-
class
azure.mgmt.cognitiveservices.models.
KeySource
[source]¶ -
An enumeration.
-
microsoft_cognitive_services
= 'Microsoft.CognitiveServices'¶
-
microsoft_key_vault
= 'Microsoft.KeyVault'¶
-
-
class
azure.mgmt.cognitiveservices.models.
PrivateEndpointServiceConnectionStatus
[source]¶ -
An enumeration.
-
approved
= 'Approved'¶
-
disconnected
= 'Disconnected'¶
-
pending
= 'Pending'¶
-
rejected
= 'Rejected'¶
-
-
class
azure.mgmt.cognitiveservices.models.
PublicNetworkAccess
[source]¶ -
An enumeration.
-
disabled
= 'Disabled'¶
-
enabled
= 'Enabled'¶
-
-
class
azure.mgmt.cognitiveservices.models.
IdentityType
[source]¶ -
An enumeration.
-
none
= 'None'¶
-
system_assigned
= 'SystemAssigned'¶
-
user_assigned
= 'UserAssigned'¶
-
-
class
azure.mgmt.cognitiveservices.models.
KeyName
[source]¶ -
An enumeration.
-
key1
= 'Key1'¶
-
key2
= 'Key2'¶
-
-
class
azure.mgmt.cognitiveservices.models.
UnitType
[source]¶ -
An enumeration.
-
bytes
= 'Bytes'¶
-
bytes_per_second
= 'BytesPerSecond'¶
-
count
= 'Count'¶
-
count_per_second
= 'CountPerSecond'¶
-
milliseconds
= 'Milliseconds'¶
-
percent
= 'Percent'¶
-
seconds
= 'Seconds'¶
-
-
class
azure.mgmt.cognitiveservices.models.
QuotaUsageStatus
[source]¶ -
An enumeration.
-
blocked
= 'Blocked'¶
-
in_overage
= 'InOverage'¶
-
included
= 'Included'¶
-
unknown
= 'Unknown'¶
-