Microsoft.CognitiveServices (stable:2025-06-01)

2025/08/19 • 7 updated methods

Accounts_Create (updated)
Description :  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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_Create",
  "$parameters": {
    "account": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
account:
{
Description: The parameters to provide for the created account. ,
Required: True ,
}
{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_Update (updated)
Description :  Updates a Cognitive Services account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_Update",
  "$parameters": {
    "account": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
account:
{
Description: The parameters to provide for the created account. ,
Required: True ,
}
{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_Get (updated)
Description :  Returns a Cognitive Services account specified by the parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedAccounts_Get (updated)
Description :  Returns a Cognitive Services account specified by the parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeletedAccounts_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "networkInjections",
            "Type": {
              "new": "array",
              "old": "object"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/resourceGroups/{resourceGroupName}/deletedAccounts/{accountName}
{
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_ListByResourceGroup (updated)
Description :  Returns all the resources of a particular type belonging to a resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "networkInjections",
                "Type": {
                  "new": "array",
                  "old": "object"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of accounts. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of Cognitive Services accounts and their properties. ,
Required: False ,
}
[
{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_List (updated)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "networkInjections",
                "Type": {
                  "new": "array",
                  "old": "object"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of accounts. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of Cognitive Services accounts and their properties. ,
Required: False ,
}
[
{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedAccounts_List (updated)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeletedAccounts_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "networkInjections",
                "Type": {
                  "new": "array",
                  "old": "object"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/deletedAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of accounts. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of Cognitive Services accounts and their properties. ,
Required: False ,
}
[
{
kind:
{
Description: The Kind of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: 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} ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services account at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
endpoint:
{
Description: Endpoint of the created account. ,
Required: False ,
}
string ,
internalId:
{
Description: The internal identifier (deprecated, do not use this property). ,
Required: False ,
}
string ,
capabilities:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SkuCapability. ,
Required: False ,
}
string ,
value:
{
Description: The value of the SkuCapability. ,
Required: False ,
}
string ,
}
,
]
,
isMigrated:
{
Description: If the resource is migrated from an existing key. ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Resource migration token. ,
Required: False ,
}
string ,
skuChangeInfo:
{
Description: Sku change info of account. ,
Required: False ,
}
{
countOfDowngrades:
{
Description: Gets the count of downgrades. ,
Required: False ,
}
number ,
countOfUpgradesAfterDowngrades:
{
Description: Gets the count of upgrades after downgrades. ,
Required: False ,
}
number ,
lastChangeDate:
{
Description: Gets the last change date. ,
Required: False ,
}
string ,
}
,
customSubDomainName:
{
Description: Optional subdomain name used for token-based authentication. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A collection of rules governing the accessibility from specific network locations. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
bypass:
{
Description: Setting for trusted services. ,
Enum:
{
None: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: The list of IP address rules. ,
Required: False ,
}
[
{
value:
{
Description: 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: True ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: The list of virtual network rules. ,
Required: False ,
}
[
{
id:
{
Description: Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ,
Required: True ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Ignore missing vnet service endpoint or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
encryption:
{
Description: The encryption properties for this resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.CognitiveServices: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userOwnedStorage:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
resourceId:
{
Description: Full resource id of a Microsoft.Storage resource. ,
Required: False ,
}
string ,
identityClientId:
{
Required: False ,
}
string ,
}
,
]
,
amlWorkspace:
{
Description: The user owned AML account properties. ,
Required: False ,
}
{
resourceId:
{
Description: Full resource id of a AML account resource. ,
Required: False ,
}
string ,
identityClientId:
{
Description: Identity Client id of a AML account resource. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The private endpoint connection associated with the Cognitive Services account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The private link resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the private endpoint connection ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
apiProperties:
{
Description: The api properties for special APIs. ,
Required: False ,
}
{
qnaRuntimeEndpoint:
{
Description: (QnAMaker Only) The runtime endpoint of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointKey:
{
Description: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. ,
Required: False ,
}
string ,
qnaAzureSearchEndpointId:
{
Description: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. ,
Required: False ,
}
string ,
statisticsEnabled:
{
Description: (Bing Search Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
boolean ,
eventHubConnectionString:
{
Description: (Personalization Only) The flag to enable statistics of Bing Search. ,
Required: False ,
}
string ,
storageAccountConnectionString:
{
Description: (Personalization Only) The storage account connection string. ,
Required: False ,
}
string ,
aadClientId:
{
Description: (Metrics Advisor Only) The Azure AD Client Id (Application Id). ,
Required: False ,
}
string ,
aadTenantId:
{
Description: (Metrics Advisor Only) The Azure AD Tenant Id. ,
Required: False ,
}
string ,
superUser:
{
Description: (Metrics Advisor Only) The super user of Metrics Advisor. ,
Required: False ,
}
string ,
websiteName:
{
Description: (Metrics Advisor Only) The website name of Metrics Advisor. ,
Required: False ,
}
string ,
}
,
dateCreated:
{
Description: Gets the date of cognitive services account creation. ,
Required: False ,
}
string ,
callRateLimit:
{
Description: The call rate limit Cognitive Services account. ,
Required: False ,
}
{
count:
{
Description: The count value of Call Rate Limit. ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled:
{
Description: The flag to enable dynamic throttling. ,
Required: False ,
}
boolean ,
quotaLimit:
{
Required: False ,
}
{
count:
{
Required: False ,
}
number ,
renewalPeriod:
{
Required: False ,
}
number ,
rules:
{
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
renewalPeriod:
{
Required: False ,
}
number ,
count:
{
Required: False ,
}
number ,
minCount:
{
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Required: False ,
}
boolean ,
matchPatterns:
{
Required: False ,
}
[
{
path:
{
Required: False ,
}
string ,
method:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess:
{
Required: False ,
}
boolean ,
allowedFqdnList:
{
Required: False ,
}
[
string ,
]
,
disableLocalAuth:
{
Required: False ,
}
boolean ,
endpoints:
{
Required: False ,
}
object ,
restore:
{
Required: False ,
}
boolean ,
deletionDate:
{
Description: The deletion date, only available for deleted account. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purge date, only available for deleted account. ,
Required: False ,
}
string ,
locations:
{
Description: The multiregion settings of Cognitive Services account. ,
Required: False ,
}
{
routingMethod:
{
Description: Multiregion routing methods. ,
Enum:
{
Priority: No description available. ,
Weighted: No description available. ,
Performance: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Required: False ,
}
[
{
name:
{
Description: Name of the region. ,
Required: False ,
}
string ,
value:
{
Description: A value for priority or weighted routing methods. ,
Required: False ,
}
number ,
customsubdomain:
{
Description: Maps the region to the regional custom subdomain. ,
Required: False ,
}
string ,
}
,
]
,
}
,
commitmentPlanAssociations:
{
Description: The commitment plan associations of Cognitive Services account. ,
Required: False ,
}
[
{
commitmentPlanId:
{
Description: The Azure resource id of the commitment plan. ,
Required: False ,
}
string ,
commitmentPlanLocation:
{
Description: The location of of the commitment plan. ,
Required: False ,
}
string ,
}
,
]
,
abusePenalty:
{
Description: The abuse penalty. ,
Required: False ,
}
{
action:
{
Description: The action of AbusePenalty. ,
Enum:
{
Throttle: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
rateLimitPercentage:
{
Description: The percentage of rate limit. ,
Required: False ,
}
number ,
expiration:
{
Description: The datetime of expiration of the AbusePenalty. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
raiMonitorConfig:
{
Description: Cognitive Services Rai Monitor Config. ,
Required: False ,
}
{
adxStorageResourceId:
{
Description: The storage resource Id. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The identity client Id to access the storage. ,
Required: False ,
}
string ,
}
,
networkInjections:
{
Required: False ,
}
[
{
scenario:
{
Description: Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. ,
Enum:
{
none: No description available. ,
agent: No description available. ,
}
,
Required: False ,
}
enum ,
subnetArmId:
{
Description: Specify the subnet for which your Agent Client is injected into. ,
Format: arm-id ,
Required: False ,
}
string ,
useMicrosoftManagedNetwork:
{
Description: Boolean to enable Microsoft Managed Network for subnet delegation ,
Required: False ,
}
boolean ,
}
,
]
,
allowProjectManagement:
{
Description: Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. ,
Required: False ,
}
boolean ,
defaultProject:
{
Description: Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects, by project name, that are associated with this resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}