AccountProperties interface
Properties of Cognitive Services account.
Properties
abuse |
The abuse penalty. NOTE: This property will not be serialized. It can only be populated by the server. |
allowed |
|
api |
The api properties for special APIs. |
call |
The call rate limit Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server. |
capabilities | 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. NOTE: This property will not be serialized. It can only be populated by the server. |
commitment |
The commitment plan associations of Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server. |
custom |
Optional subdomain name used for token-based authentication. |
date |
Gets the date of cognitive services account creation. NOTE: This property will not be serialized. It can only be populated by the server. |
deletion |
The deletion date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server. |
disable |
|
dynamic |
The flag to enable dynamic throttling. |
encryption | The encryption properties for this resource. |
endpoint | Endpoint of the created account. NOTE: This property will not be serialized. It can only be populated by the server. |
endpoints | Dictionary of NOTE: This property will not be serialized. It can only be populated by the server. |
internal |
The internal identifier (deprecated, do not use this property). NOTE: This property will not be serialized. It can only be populated by the server. |
is |
If the resource is migrated from an existing key. NOTE: This property will not be serialized. It can only be populated by the server. |
locations | The multiregion settings of Cognitive Services account. |
migration |
Resource migration token. |
network |
A collection of rules governing the accessibility from specific network locations. |
private |
The private endpoint connection associated with the Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server. |
provisioning |
Gets the status of the cognitive services account at the time the operation was called. NOTE: This property will not be serialized. It can only be populated by the server. |
public |
Whether or not public endpoint access is allowed for this account. |
quota |
NOTE: This property will not be serialized. It can only be populated by the server. |
restore | |
restrict |
|
scheduled |
The scheduled purge date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server. |
sku |
Sku change info of account. NOTE: This property will not be serialized. It can only be populated by the server. |
user |
The storage accounts for this resource. |
Property Details
abusePenalty
The abuse penalty. NOTE: This property will not be serialized. It can only be populated by the server.
abusePenalty?: AbusePenalty
Property Value
allowedFqdnList
allowedFqdnList?: string[]
Property Value
string[]
apiProperties
callRateLimit
The call rate limit Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.
callRateLimit?: CallRateLimit
Property Value
capabilities
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. NOTE: This property will not be serialized. It can only be populated by the server.
capabilities?: SkuCapability[]
Property Value
commitmentPlanAssociations
The commitment plan associations of Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.
commitmentPlanAssociations?: CommitmentPlanAssociation[]
Property Value
customSubDomainName
Optional subdomain name used for token-based authentication.
customSubDomainName?: string
Property Value
string
dateCreated
Gets the date of cognitive services account creation. NOTE: This property will not be serialized. It can only be populated by the server.
dateCreated?: string
Property Value
string
deletionDate
The deletion date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server.
deletionDate?: string
Property Value
string
disableLocalAuth
disableLocalAuth?: boolean
Property Value
boolean
dynamicThrottlingEnabled
The flag to enable dynamic throttling.
dynamicThrottlingEnabled?: boolean
Property Value
boolean
encryption
endpoint
Endpoint of the created account. NOTE: This property will not be serialized. It can only be populated by the server.
endpoint?: string
Property Value
string
endpoints
Dictionary of NOTE: This property will not be serialized. It can only be populated by the server.
endpoints?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
internalId
The internal identifier (deprecated, do not use this property). NOTE: This property will not be serialized. It can only be populated by the server.
internalId?: string
Property Value
string
isMigrated
If the resource is migrated from an existing key. NOTE: This property will not be serialized. It can only be populated by the server.
isMigrated?: boolean
Property Value
boolean
locations
The multiregion settings of Cognitive Services account.
locations?: MultiRegionSettings
Property Value
migrationToken
Resource migration token.
migrationToken?: string
Property Value
string
networkAcls
A collection of rules governing the accessibility from specific network locations.
networkAcls?: NetworkRuleSet
Property Value
privateEndpointConnections
The private endpoint connection associated with the Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections?: PrivateEndpointConnection[]
Property Value
provisioningState
Gets the status of the cognitive services account at the time the operation was called. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
publicNetworkAccess
Whether or not public endpoint access is allowed for this account.
publicNetworkAccess?: string
Property Value
string
quotaLimit
NOTE: This property will not be serialized. It can only be populated by the server.
quotaLimit?: QuotaLimit
Property Value
restore
restore?: boolean
Property Value
boolean
restrictOutboundNetworkAccess
restrictOutboundNetworkAccess?: boolean
Property Value
boolean
scheduledPurgeDate
The scheduled purge date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server.
scheduledPurgeDate?: string
Property Value
string
skuChangeInfo
Sku change info of account. NOTE: This property will not be serialized. It can only be populated by the server.
skuChangeInfo?: SkuChangeInfo
Property Value
userOwnedStorage
The storage accounts for this resource.
userOwnedStorage?: UserOwnedStorage[]