Accounts - Create
Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2024-10-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The name of Cognitive Services account. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
identity |
Identity for the resource. |
|
kind |
string |
The Kind of the resource. |
location |
string |
The geo-location where the resource lives |
properties |
Properties of Cognitive Services account. |
|
sku |
The resource model definition representing SKU |
|
tags |
object |
Resource tags. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
If resource is created successfully or already existed, the service should return 200 (OK). |
|
201 Created |
If resource is created successfully, the service should return 201 (OK). |
|
202 Accepted |
HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously. |
|
Other Status Codes |
Error response describing why the operation failed |
Examples
Create Account |
Create Account Min |
Create Account
Sample request
PUT https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1?api-version=2024-10-01
{
"location": "West US",
"kind": "Emotion",
"sku": {
"name": "S0"
},
"properties": {
"encryption": {
"keyVaultProperties": {
"keyName": "KeyName",
"keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
"keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
},
"keySource": "Microsoft.KeyVault"
},
"userOwnedStorage": [
{
"resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
}
]
},
"identity": {
"type": "SystemAssigned"
}
}
Sample response
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
"name": "testCreate1",
"type": "Microsoft.CognitiveServices/accounts",
"location": "West US",
"sku": {
"name": "S0"
},
"kind": "Emotion",
"etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded",
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": {
"keyName": "FakeKeyName",
"keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
"keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
}
},
"userOwnedStorage": [
{
"resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
}
]
},
"identity": {
"principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
"type": "SystemAssigned"
}
}
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
"name": "testCreate1",
"type": "Microsoft.CognitiveServices/accounts",
"location": "West US",
"sku": {
"name": "S0"
},
"kind": "Emotion",
"etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded",
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": {
"keyName": "FakeKeyName",
"keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
"keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
}
},
"userOwnedStorage": [
{
"resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
}
]
},
"identity": {
"principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
"type": "SystemAssigned"
}
}
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
"name": "testCreate1",
"type": "Microsoft.CognitiveServices/accounts",
"location": "West US",
"sku": {
"name": "S0"
},
"kind": "Emotion",
"etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded",
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": {
"keyName": "FakeKeyName",
"keyVersion": "891CF236-D241-4738-9462-D506AF493DFA",
"keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/"
}
},
"userOwnedStorage": [
{
"resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
}
]
},
"identity": {
"principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
"type": "SystemAssigned"
}
}
Create Account Min
Sample request
PUT https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1?api-version=2024-10-01
{
"location": "West US",
"kind": "CognitiveServices",
"sku": {
"name": "S0"
},
"properties": {},
"identity": {
"type": "SystemAssigned"
}
}
Sample response
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
"name": "testCreate1",
"type": "Microsoft.CognitiveServices/accounts",
"location": "West US",
"sku": {
"name": "S0"
},
"kind": "Emotion",
"etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded"
},
"identity": {
"principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
"type": "SystemAssigned"
}
}
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
"name": "testCreate1",
"type": "Microsoft.CognitiveServices/accounts",
"location": "West US",
"sku": {
"name": "S0"
},
"kind": "Emotion",
"etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded"
},
"identity": {
"principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
"type": "SystemAssigned"
}
}
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
"name": "testCreate1",
"type": "Microsoft.CognitiveServices/accounts",
"location": "West US",
"sku": {
"name": "S0"
},
"kind": "Emotion",
"etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded"
},
"identity": {
"principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
"type": "SystemAssigned"
}
}
Definitions
Name | Description |
---|---|
Abuse |
The abuse penalty. |
Abuse |
The action of AbusePenalty. |
Account |
Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU. |
Account |
Properties of Cognitive Services account. |
Api |
The api properties for special APIs. |
By |
Setting for trusted services. |
Call |
The call rate limit Cognitive Services account. |
Commitment |
The commitment plan association. |
created |
The type of identity that created the resource. |
Encryption |
Properties to configure Encryption |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Identity |
Identity for the resource. |
Ip |
A rule governing the accessibility from a specific ip address or ip range. |
key |
Enumerates the possible value of keySource for Encryption |
Key |
Properties to configure keyVault Properties |
Multi |
The multiregion settings Cognitive Services account. |
Network |
The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. |
Network |
A set of rules governing the network accessibility. |
Private |
The Private Endpoint resource. |
Private |
The Private Endpoint Connection resource. |
Private |
Properties of the PrivateEndpointConnectProperties. |
Private |
The current provisioning state. |
Private |
The private endpoint connection status. |
Private |
A collection of information about the state of the connection between service consumer and provider. |
Provisioning |
Gets the status of the cognitive services account at the time the operation was called. |
Public |
Whether or not public endpoint access is allowed for this account. |
Quota |
|
Rai |
Cognitive Services Rai Monitor Config. |
Region |
The call rate limit Cognitive Services account. |
Request |
|
Resource |
The identity type. |
Routing |
Multiregion routing methods. |
Sku |
The resource model definition representing SKU |
Sku |
SkuCapability indicates the capability of a certain feature. |
Sku |
Sku change info of account. |
Sku |
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. |
system |
Metadata pertaining to creation and last modification of the resource. |
Throttling |
|
User |
User-assigned managed identity. |
User |
The user owned AML workspace for Cognitive Services account. |
User |
The user owned storage for Cognitive Services account. |
Virtual |
A rule governing the accessibility from a specific virtual network. |
AbusePenalty
The abuse penalty.
Name | Type | Description |
---|---|---|
action |
The action of AbusePenalty. |
|
expiration |
string |
The datetime of expiration of the AbusePenalty. |
rateLimitPercentage |
number |
The percentage of rate limit. |
AbusePenaltyAction
The action of AbusePenalty.
Name | Type | Description |
---|---|---|
Block |
string |
|
Throttle |
string |
Account
Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
Name | Type | Description |
---|---|---|
etag |
string |
Resource Etag. |
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Identity for the resource. |
|
kind |
string |
The Kind of the resource. |
location |
string |
The geo-location where the resource lives |
name |
string |
The name of the resource |
properties |
Properties of Cognitive Services account. |
|
sku |
The resource model definition representing SKU |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
tags |
object |
Resource tags. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
AccountProperties
Properties of Cognitive Services account.
Name | Type | Description |
---|---|---|
abusePenalty |
The abuse penalty. |
|
allowedFqdnList |
string[] |
|
amlWorkspace |
The user owned AML workspace properties. |
|
apiProperties |
The api properties for special APIs. |
|
callRateLimit |
The call rate limit Cognitive Services account. |
|
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. |
|
commitmentPlanAssociations |
The commitment plan associations of Cognitive Services account. |
|
customSubDomainName |
string |
Optional subdomain name used for token-based authentication. |
dateCreated |
string |
Gets the date of cognitive services account creation. |
deletionDate |
string |
The deletion date, only available for deleted account. |
disableLocalAuth |
boolean |
|
dynamicThrottlingEnabled |
boolean |
The flag to enable dynamic throttling. |
encryption |
The encryption properties for this resource. |
|
endpoint |
string |
Endpoint of the created account. |
endpoints |
object |
|
internalId |
string |
The internal identifier (deprecated, do not use this property). |
isMigrated |
boolean |
If the resource is migrated from an existing key. |
locations |
The multiregion settings of Cognitive Services account. |
|
migrationToken |
string |
Resource migration token. |
networkAcls |
A collection of rules governing the accessibility from specific network locations. |
|
privateEndpointConnections |
The private endpoint connection associated with the Cognitive Services account. |
|
provisioningState |
Gets the status of the cognitive services account at the time the operation was called. |
|
publicNetworkAccess |
Whether or not public endpoint access is allowed for this account. |
|
quotaLimit | ||
raiMonitorConfig |
Cognitive Services Rai Monitor Config. |
|
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
The scheduled purge date, only available for deleted account. |
skuChangeInfo |
Sku change info of account. |
|
userOwnedStorage |
The storage accounts for this resource. |
ApiProperties
The api properties for special APIs.
Name | Type | Description |
---|---|---|
aadClientId |
string |
(Metrics Advisor Only) The Azure AD Client Id (Application Id). |
aadTenantId |
string |
(Metrics Advisor Only) The Azure AD Tenant Id. |
eventHubConnectionString |
string |
(Personalization Only) The flag to enable statistics of Bing Search. |
qnaAzureSearchEndpointId |
string |
(QnAMaker Only) The Azure Search endpoint id of QnAMaker. |
qnaAzureSearchEndpointKey |
string |
(QnAMaker Only) The Azure Search endpoint key of QnAMaker. |
qnaRuntimeEndpoint |
string |
(QnAMaker Only) The runtime endpoint of QnAMaker. |
statisticsEnabled |
boolean |
(Bing Search Only) The flag to enable statistics of Bing Search. |
storageAccountConnectionString |
string |
(Personalization Only) The storage account connection string. |
superUser |
string |
(Metrics Advisor Only) The super user of Metrics Advisor. |
websiteName |
string |
(Metrics Advisor Only) The website name of Metrics Advisor. |
ByPassSelection
Setting for trusted services.
Name | Type | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
CallRateLimit
The call rate limit Cognitive Services account.
Name | Type | Description |
---|---|---|
count |
number |
The count value of Call Rate Limit. |
renewalPeriod |
number |
The renewal period in seconds of Call Rate Limit. |
rules |
CommitmentPlanAssociation
The commitment plan association.
Name | Type | Description |
---|---|---|
commitmentPlanId |
string |
The Azure resource id of the commitment plan. |
commitmentPlanLocation |
string |
The location of of the commitment plan. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
Properties to configure Encryption
Name | Type | Default value | Description |
---|---|---|---|
keySource | Microsoft.KeyVault |
Enumerates the possible value of keySource for Encryption |
|
keyVaultProperties |
Properties of KeyVault |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
Identity
Identity for the resource.
Name | Type | Description |
---|---|---|
principalId |
string |
The principal ID of resource identity. |
tenantId |
string |
The tenant ID of resource. |
type |
The identity type. |
|
userAssignedIdentities |
<string,
User |
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} |
IpRule
A rule governing the accessibility from a specific ip address or ip range.
Name | Type | Description |
---|---|---|
value |
string |
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). |
keySource
Enumerates the possible value of keySource for Encryption
Name | Type | Description |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
Properties to configure keyVault Properties
Name | Type | Description |
---|---|---|
identityClientId |
string |
|
keyName |
string |
Name of the Key from KeyVault |
keyVaultUri |
string |
Uri of KeyVault |
keyVersion |
string |
Version of the Key from KeyVault |
MultiRegionSettings
The multiregion settings Cognitive Services account.
Name | Type | Description |
---|---|---|
regions |
The call rate limit Cognitive Services account. |
|
routingMethod |
Multiregion routing methods. |
NetworkRuleAction
The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
Name | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleSet
A set of rules governing the network accessibility.
Name | Type | Description |
---|---|---|
bypass |
Setting for trusted services. |
|
defaultAction |
The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. |
|
ipRules |
Ip |
The list of IP address rules. |
virtualNetworkRules |
The list of virtual network rules. |
PrivateEndpoint
The Private Endpoint resource.
Name | Type | Description |
---|---|---|
id |
string |
The ARM identifier for Private Endpoint |
PrivateEndpointConnection
The Private Endpoint Connection resource.
Name | Type | Description |
---|---|---|
etag |
string |
Resource Etag. |
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
The location of the private endpoint connection |
name |
string |
The name of the resource |
properties |
Resource properties. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
Properties of the PrivateEndpointConnectProperties.
Name | Type | Description |
---|---|---|
groupIds |
string[] |
The private link resource group ids. |
privateEndpoint |
The resource of private end point. |
|
privateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
|
provisioningState |
The provisioning state of the private endpoint connection resource. |
PrivateEndpointConnectionProvisioningState
The current provisioning state.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
The private endpoint connection status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
A message indicating if changes on the service provider require any updates on the consumer. |
description |
string |
The reason for approval/rejection of the connection. |
status |
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
ProvisioningState
Gets the status of the cognitive services account at the time the operation was called.
Name | Type | Description |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
ResolvingDNS |
string |
|
Succeeded |
string |
PublicNetworkAccess
Whether or not public endpoint access is allowed for this account.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
QuotaLimit
Name | Type | Description |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RaiMonitorConfig
Cognitive Services Rai Monitor Config.
Name | Type | Description |
---|---|---|
adxStorageResourceId |
string |
The storage resource Id. |
identityClientId |
string |
The identity client Id to access the storage. |
RegionSetting
The call rate limit Cognitive Services account.
Name | Type | Description |
---|---|---|
customsubdomain |
string |
Maps the region to the regional custom subdomain. |
name |
string |
Name of the region. |
value |
number |
A value for priority or weighted routing methods. |
RequestMatchPattern
Name | Type | Description |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
The identity type.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RoutingMethods
Multiregion routing methods.
Name | Type | Description |
---|---|---|
Performance |
string |
|
Priority |
string |
|
Weighted |
string |
Sku
The resource model definition representing SKU
Name | Type | Description |
---|---|---|
capacity |
integer |
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. |
family |
string |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
name |
string |
The name of the SKU. Ex - P3. It is typically a letter+number code |
size |
string |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. |
tier |
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. |
SkuCapability
SkuCapability indicates the capability of a certain feature.
Name | Type | Description |
---|---|---|
name |
string |
The name of the SkuCapability. |
value |
string |
The value of the SkuCapability. |
SkuChangeInfo
Sku change info of account.
Name | Type | Description |
---|---|---|
countOfDowngrades |
number |
Gets the count of downgrades. |
countOfUpgradesAfterDowngrades |
number |
Gets the count of upgrades after downgrades. |
lastChangeDate |
string |
Gets the last change date. |
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.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
ThrottlingRule
Name | Type | Description |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |
UserAssignedIdentity
User-assigned managed identity.
Name | Type | Description |
---|---|---|
clientId |
string |
Client App Id associated with this identity. |
principalId |
string |
Azure Active Directory principal ID associated with this Identity. |
UserOwnedAmlWorkspace
The user owned AML workspace for Cognitive Services account.
Name | Type | Description |
---|---|---|
identityClientId |
string |
Identity Client id of a AML workspace resource. |
resourceId |
string |
Full resource id of a AML workspace resource. |
UserOwnedStorage
The user owned storage for Cognitive Services account.
Name | Type | Description |
---|---|---|
identityClientId |
string |
|
resourceId |
string |
Full resource id of a Microsoft.Storage resource. |
VirtualNetworkRule
A rule governing the accessibility from a specific virtual network.
Name | Type | Description |
---|---|---|
id |
string |
Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. |
ignoreMissingVnetServiceEndpoint |
boolean |
Ignore missing vnet service endpoint or not. |
state |
string |
Gets the state of virtual network rule. |