Microsoft.CognitiveServices (preview:2025-04-01)

2025/04/10 • 11 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": [
          {
            "@added_c4054fce1c4c49a5b3c3f06dbcb5b7a4": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_1f62c52e4ad346e29fc9c76f4a2c6ec9": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_aa036d61586545afb8c7b43a9b1c19d8": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_3412f27267aa4a1b8448491ec70b1453": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_a418e142241344d8b9514db94e5f3ae8": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_5ddb08e51bb6451b86c9c1be3d48d37e": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_0b0f4ec3b60846cb91bcd9120d1aac51": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_67fff95159174054b0e716e03df4ee40": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "@added_243b6e09139d43a8960437dd561288b9": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_2e92a42ee89b41b5b5ee7e53326c63c8": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_98248537d9b9408cbb6234c92214a4fb": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_7c43f3532ad04fd5954dd3b58ec8ded0": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "@added_c87fc44714824d088071ee89ed6af3e3": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_4bf013e4cddd4ce9bc4e5ab620b6ec0b": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_785311eae8424896ac9865b99ee3ad3a": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_5d41633ca1ff4a4bb5e1f095325a0a33": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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": [
          {
            "@added_3613382e2ed44acd98fe3429bee58c43": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_05cff7ba5bf04807a8f2f32d1425e3b0": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_a131c52c019d4c6e96bc04714c89df7b": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_73c916a26ee54a1cab6b42d5c251cafd": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_24d2d01c61b54c9f827a18e83bef14f7": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_7d7fc8a2391c42d595caa6833b0baeb0": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_5e42fed7945741baa926fcd3cc666ba1": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_c379c0a24410497c82188b5880bf103c": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "@added_beca08fbabd646058a07282a7fe03b6a": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_e4560acd461f46ecb88b1f0ca9ba66f5": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_ced7e54daff74cf8a57698651247ff58": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_134515ce81ee42b3ba3fecbdf03eb10d": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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": [
          {
            "@added_fa336ccfae8747559e573995f3976667": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_889deccd1c0643aca4bd70a742fec4d1": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_0ac54dec587348ac9dd965b9ce334718": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_aacbdb79d0044beca2bd3d18a3cf357c": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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": [
          {
            "@added_0c2a46ed9f894e8c8596e8b5201800eb": {
              "#name": "networkInjections",
              "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "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",
                      ""
                    ],
                    [
                      "agent",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "subnetArmId",
                  "Description": "Specify the subnet for which your Agent Client is injected into.",
                  "Format": "arm-id",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "useMicrosoftManagedNetwork",
                  "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@added_a7d33cc36fb8468585650cfcdc5b097c": {
              "#name": "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,
              "Type": "boolean"
            }
          },
          {
            "@added_ea6a8209dadd4f2fb019fa15bf6b40d1": {
              "#name": "defaultProject",
              "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@added_3c8244f3877740e786ab7a1188a2e61d": {
              "#name": "associatedProjects",
              "Description": "Specifies the projects that are associated with this resource.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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": [
              {
                "@added_6ce3c9b19b08464bacbfb0cf627967ad": {
                  "#name": "networkInjections",
                  "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "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",
                          ""
                        ],
                        [
                          "agent",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "subnetArmId",
                      "Description": "Specify the subnet for which your Agent Client is injected into.",
                      "Format": "arm-id",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "useMicrosoftManagedNetwork",
                      "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                      "Required": false,
                      "Type": "boolean"
                    }
                  ]
                }
              },
              {
                "@added_8cc2c1cf2d504ec38668156f098b5fbf": {
                  "#name": "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,
                  "Type": "boolean"
                }
              },
              {
                "@added_abb27d0ef34e466ba456ca96998a4805": {
                  "#name": "defaultProject",
                  "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@added_f4b21c7a6cbe470982551be53105cfd3": {
                  "#name": "associatedProjects",
                  "Description": "Specifies the projects that are associated with this resource.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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": [
              {
                "@added_0aca6f5fe3734a26bd7a0ff0b3edd63b": {
                  "#name": "networkInjections",
                  "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "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",
                          ""
                        ],
                        [
                          "agent",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "subnetArmId",
                      "Description": "Specify the subnet for which your Agent Client is injected into.",
                      "Format": "arm-id",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "useMicrosoftManagedNetwork",
                      "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                      "Required": false,
                      "Type": "boolean"
                    }
                  ]
                }
              },
              {
                "@added_518f48fbea764b8098c49bc242671959": {
                  "#name": "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,
                  "Type": "boolean"
                }
              },
              {
                "@added_26ddf535075b42ef91b7b5788dc58137": {
                  "#name": "defaultProject",
                  "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@added_dabbbeea2a3049988738388c13e10b4d": {
                  "#name": "associatedProjects",
                  "Description": "Specifies the projects that are associated with this resource.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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": [
              {
                "@added_29bee9bb73e64075b3d3c545af9f0b8a": {
                  "#name": "networkInjections",
                  "Description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "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",
                          ""
                        ],
                        [
                          "agent",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "subnetArmId",
                      "Description": "Specify the subnet for which your Agent Client is injected into.",
                      "Format": "arm-id",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "useMicrosoftManagedNetwork",
                      "Description": "Boolean to enable Microsoft Managed Network for subnet delegation",
                      "Required": false,
                      "Type": "boolean"
                    }
                  ]
                }
              },
              {
                "@added_b839d53b3d364cdd951777dcfa56884d": {
                  "#name": "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,
                  "Type": "boolean"
                }
              },
              {
                "@added_0c9ee488352d465a98cb56f3f360869d": {
                  "#name": "defaultProject",
                  "Description": "Specifies the project that is targeted when data plane endpoints are called without a project parameter.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@added_3387447fdb5e461893f0358b469de835": {
                  "#name": "associatedProjects",
                  "Description": "Specifies the projects that are associated with this resource.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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:
{
Description: Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. ,
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 that is targeted when data plane endpoints are called without a project parameter. ,
Required: False ,
}
string ,
associatedProjects:
{
Description: Specifies the projects 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 ,
}
,
]
,
}
,
}
Projects_Create (updated)
Description :  Create Cognitive Services Account's Project. Project is a sub-resource of an account which give AI developer it's individual container to work on.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Projects_Create",
  "$parameters": {
    "project": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_bae49d788b9a42ffaf50c91716112cba": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_30a341af6b2f42208e4c2db41459c2e5": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_0a04f6c698654df0b4d8fe32f2d93a3e": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_2b8eb45a72734743bcb8d44fdc963e6e": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_bc184f7a1bb24b33abe9bb5180fbff3a": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_cb4abef45c72420287bd078b91588a80": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_27da26394db64efc9c159a103298c370": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_e9f7064c9c294f5e9eb1411a31fabafe": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_ad1525b1af6b4731ba09f8eef23a2e44": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_2469a92979524bcba92ed0f9fa4e04fb": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_b463301707694d2c915a1ec1e570e5f2": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_1f5c4b22129e4e38a52bb169e31c445e": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_d6f004a588044b61a45a9daa9ac02fc8": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_eef8d6d680a841ec9ed79f0e7cfcb911": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_861f1fbf4dc840d7a1720e24c57a4f13": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_f6d918ace2334e2a8b30f6bbaaeec978": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_edb497487e334cee9aad31c98992796c": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_98f8e08ca19f4f4ea06b865947fad3b2": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_9b95776e729c446b865d19b49d0f86aa": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_0f584c1d848c41e5ba89545c4cca198a": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_b779980728454974964d1d2fda94aece": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_89e4371689a0470d823440265e9a4783": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_90ba56d37a4742bb9ad4e510e5f413ce": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_da9fb869855a4db7b150526bdded13b2": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_ad028dedc81b4070bca6336d4e373638": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_dfe7c5f30e0e421aa55f3836ae3690d8": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_68ee46a29322459cad39f41459a65e86": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_d42361e3d2fa44ab9f37e43265ce1afe": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_137e50bef6eb47b1acdead0550aa8207": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_766631adf1404f2b8f6034875ce12159": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_5fde4a2aec8b4e84902d669fd9e9c2d2": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_61531475170c409280990863a2c4d776": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_10236187ec754b7aa7d93a933249f240": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_be2027eb748a44a0a8c5fd2dac97657e": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_dd551d87e42d4d94ba16dac490dfd699": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_d0504f9637e1469b919f77621d3bb8aa": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_127ee2ed2aa1467aaee64b38a04ace00": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_4a6040a4af284993a21964b57ec646c9": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_a9d649ef97a641cc81743d3dba3ede75": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_d4df913b15e34a6e895d727038d6bb37": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_7498bb9393a14910bd27774f9e930054": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_44ea80515deb47a5b44b9813e4932bd4": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_e46d52d8a4f1443c9cba96b63c597834": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_abb733075112415ca5916dca6a9da02c": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_56ad064ae683454dafbdea2934bfdf16": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_af338c8f0c664723ba12c7b6d020c027": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_95c45a5fb11e4f679881334696c373b9": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_93e6ea2aa1aa447c83070163f776b530": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_d43c534060354c93a07d2ff8da90c0e4": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_a85092d718b94262ab6390125fa4b9a0": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_597d4b348f8f478db280b43c74ef4362": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_933805c6f96b4bb9bc353eef3bbe3bd4": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_6fc4a84c22654d29a27db56597964a85": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_d4889745672b4ecd89c7804ca80ea25d": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_9ed4da48a8df404f863293d6686f08fb": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_512ec93ffddb47a299590d91ce100198": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_375ce52e1e034a458a0d2e6292520b2e": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_677f51f122ec42358c0c3810accdd60f": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_c9a36e01939643f48eeb5cccee15306e": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_cfe94c8f24e74712a937f0f8112b35d2": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_66330a35a4224891996a40915d00bb68": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_f94779ba0abe4d0781a70682dae4ebd8": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_0792173794444f7fb5d519acb6c31da5": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_199b8f7a4ee44d128c63cc3550a43b76": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_24c80b1e0253401f9b066eefac48b5c1": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_61ad89453e6b4b538f3e8165f481872d": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_90d5fad2d0cd4df2ae1fb4b365c9553f": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_ad1e0bed80bc426ea25c6174d1d50426": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_6e5fd33cf03d4b138dabb9f21d06d231": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_5b0565f08e044c20b7753d0601035596": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_090fb443e3ad4cf488fb6214afe0e156": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_7c5058c212044312b6e685ba95b19b21": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_38a6c5eb895042a9a5c11f246e691813": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_4e9c49a5600d44a8aa9812a74cf6789c": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_b5fe40ab529d4643be8089a25bd92185": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_a55c796168ea4644a053d7be52893e07": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_e20d8a1be91a4e178ee9d36deceb28ef": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_97d7f91d2fe345ff99c25b7ddcd2e509": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_9c3ffecb55994101be7c5abf5e9ddf8b": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_ee47ab031fdf4370847145e6875bf24a": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_38697077c0924377b03613d591444488": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_d7d23a13bfd94536bdd8e8558dcb53c5": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_440ba939b1f74af095fe055d9e6c9918": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_3474ebe5685e4b81b0c6335449f08939": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_03138eab82534eaebada35340c0d9d44": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_c91de736eef94b7187653324432cbd40": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_acc1ca326e92476a99a7942ac073d151": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_0b810701034947209dbb2d4793fe8a2e": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_64c7837395e1421f920e15daa7f3db7c": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_d020c47894894066a9c3571fb92f4707": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_bb27af7ef1be4796a4cd01e64f1a3152": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_c95ff8abb7754d14a7db38eede147d81": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_ce4fa39d88cf4de0872c413a4ebed2f2": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_6dcfe4e5e06945d4b49dd6de13c8face": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_b39265a46e5a44dda77fbab309164582": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_553069178c364eb29806eb46f5c87c3f": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_171c771278cc402fb3a9c35e13509ece": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_94ea5440c1d9469e9dd20831f8fc7671": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_0306fb6c3eb545a5a288228ac2a81e65": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    },
    "202": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_c7219b96324d459a9f37416b7c777a47": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_e42c84acd96543359640c548a2d58a9f": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_a2f26241b59b4c44acdaf4ae32026ca4": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_d2a25cb21d2d406a9c23cf4932ca20c3": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_d8af371083b34528a3472e3d1aac5b38": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_9af2a26e7f8f44eba72a122aa38965bb": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_0a773207953546d0b9bddbdd9a887407": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_a50f19eb660c4c238de174bb9ab133dc": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_cfcd9bed937c486d9a3c98e42e7517a1": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_d6d655546a4041029e3cf9db33debec9": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_2e262de6e5cb43cf93882ac0fef2a8ff": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_873e54e220f5460f8b73833b9df42224": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_9543348f11e7494491aa7009ec4cfa9f": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_61ba4669ffba49619f7123a7d947bc60": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_fe7a4143643b413a8669dddbb0b85591": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_ea89e784e5714e52a69b110b3af2a641": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_641ab37bf8684b7bb53ac6b6c9609944": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_964d72e77c454f228fdff6807fe78f3e": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_8ecf49066a544ca983d657f9195ba867": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_1ff97ae2f0e2408b829301b87ec85c2c": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_2fc5a2cb2707440f80312ef596b5126a": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_d33f2d6927ab47678b79e46b3a470b7b": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_45320b5650d9491b873385e7989b86b4": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_9dc60771a699435e83f1e202ec55ede3": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_d09276d67d444780b7ce385274744d4e": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_09767b8fc1a347648e61ce3639fcb5e8": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_4a20b2dd383444f1a31c55956dc7f4e8": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_8e4efad8237c47fbac0dac496358cda9": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_137e4f1a46be4d7996a48f58de84624f": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_88e01ac554e14c7f8a2ea8b046effd3a": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_58d75eb67cc24bda9202d2a67e8b90a1": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_1250e2f7454244a893df66381c81c252": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_3ed15b8914f54ce0896680dcd1eab13c": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}
{
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 ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
project:
{
Description: The parameters to provide for the created project. ,
Required: True ,
}
{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}
,
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)

{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Projects_Update (updated)
Description :  Updates a Cognitive Services Project
Reference :  Link ¶

⚶ Changes

{
  "#id": "Projects_Update",
  "$parameters": {
    "project": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_6d2328b235134d1ca1145fd9d71060c6": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_d755b69bbf384926af0bca70c7297cae": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_554ca343ffba4be1b2c882fd8c9d23c5": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_ab502754d2754653bd7dbb06abd2ea11": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_6f9736af4548434fba26b457ae100f55": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_97f2d267d63a4cec89d299fe185e335f": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_8ed9a424f1fe46d9a76517d7b57975d4": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_6a745b5dd4154d91b4023efd3c2d7843": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_cd83c7bb7624497584248e8ef975ad4e": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_e9b130d30d9b4a16af1f3b0a3731bcd4": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_7e41c353f1d640dc9ceddb6788ceec7c": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_b013dac722f646e3aeaa701e4e5bd87a": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_3ac1d85e641040438153649ee497a5fb": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_1ac7d959d2b94bd99289a74c2f2c4a64": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_03a6c960b10b4f22938ecfb552ad289c": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_ead2b049060c4613aad2125dfff03dd6": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_e0baa3eef39c47f6a2b013a24f38e025": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_286ff87ab2b646438cd19219ef678ef5": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_cd76e2ccd3184943957dab720908db11": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_73faa21b927349788a921e2e00a21e52": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_86118f46906e4918bffc779dc11e22ae": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_794ed2d8cd00450ca60f20ed27d0cc51": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_39055c35b1444082a2da4becc91ecb48": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_a90859574d35484aaaa2f8d331b3f17b": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_0e975c5585ca4ce18a026946ab408573": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_14689b7c4a034547846e9a986811f3d5": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_7b3e3cd9401a469baf47f918c294fe9f": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_36dba1cca2114d7c9d35efe182370b2e": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_d03eae2186bc43ca9d964d3beb52c7cd": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_c8fcb7bc1cfa491282676d54355169b3": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_1fd0f656357741ec92cfdf748b4c5db5": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_58a30fa0049b4dd7ba78b8c51d78b9dc": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_af3a3c6a925641999d4bd3a09554588c": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_19b3baf9116245b6b01f809c53577883": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_e345ac92697349c59736d3edc31b6de0": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_708dad20d697481f993f5bfe5582b57a": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_5db573cdeda14492918519384e0e41f7": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_146b316891584d75bd32798f7e3d1b9b": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_1eadf1fe6ccc4b02a7ac3cb3ddb274f4": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_7be52dfde72b43aaace59f5a279fa39e": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_674bc740470041daa3be82e26adc3df8": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_b6b12c4122184f6e809159f7fad23207": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_01b41860486e4f118b2e143af86b5f3f": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_55eaee3d0e5648c5bdaea53336e99685": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_26ad434e3e064de98fc4425c825ebc29": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_8d9c681174584956870dca35a745550c": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_5e00926feeb947528f8a340c6186ab2f": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_c5ab53c6db304ec6a04c3697b8642994": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_1b46fb68434c487cb6d8928d8cdd1d50": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_cd061a7b49484cbc84d6e5d0af2dd499": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_454eec20d5c54c01b5f301490c0b2582": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_d6de20d9deea4241b31f729f767239c2": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_caf523ff0c2444fba1ebd7c4e75f9eb2": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_3ccc97f33e194886b90f19a80421548a": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_c9d47ac3821c42d4b46b0bcfc0071bfc": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_bad660c80aa040b9963a83baa0a817ff": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_f9bd998a14ea4b8a88f931fc8f733055": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_4bd5b9f6bc804c7d84b725c2841abb4f": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_2f415fcc3a9d43e9b0bc2d4f9d495551": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_41e492c61c9647ffba2fec230162bf15": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_80f1654c205e4aaa8f8098b755a83428": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_059af11437084e95acedeb502a2834b1": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_196495af4fae420cb3183b75004f8865": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_3992d75da97041dab58b43291c899f2e": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_22dcce3af5064791b5503aa20df2c96b": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_4c78e6c0ff8f403797e501364ff79490": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    },
    "202": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_9d3c7d32a704419fb5a7bdc44bae8077": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_b361497b3457426e89acb88ce85a1031": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_60ddecbd9bc14ab0b427e17c9f2bfda4": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_1a80a1b4e6a9481b99be4b39ec38f720": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_7699648da2984ae59edf1355dbf7efd4": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_e178c217551841df86d45e615b3349eb": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_3d0b9dcc8779488bbfb87a801b683318": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_e8c37d7fd08b418ab1d3d316c8a44edd": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_74634aaa95fa413a9e0acb168f6f2b76": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_d6088498424c4c6b844664609284134b": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_5249830840d74064b505198d30853e1b": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_1cff158456634edca45f821cec9f4e99": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_4152c8fbecce4f989a129ddcea528d5f": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_62cc998d31734f7dbadb153f56b0dd98": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_202de301804c4676a72b42bc2ece3793": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_039002fdd8a14d638d89a80e3b183210": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_39c79d596362442f8d13f21d488c1ee8": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_24d3fd7660974ba6a5d26b0c37921b9e": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_78c9b1c30b9e466183feba690f238fb8": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_1982fd7545204d859862eaad4748e38a": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_97fbea615a374be193677ac61dcd4db4": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_ca5d09c07efe495ba5381bc07bf3be56": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_a4add755724f4e71863d114d6fa66991": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_712e16d5d7b6444bafe26811d054572c": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_739c6b66652749a39e64e1905956c83b": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_0efde121937140bd9623502c6ee73630": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_db1437bdba024cde83983dde20c4f52a": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_427471716c764a3e93a2b908a3035a52": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_be75ec77185544b7b3f34f6f99adef9a": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_1f9dab5c92994bcba0c124d5d4b2a6bb": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_2b747752bcbe4abaaf2594bdeb705f4c": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_7c20917ee1e343b0b40db6a75efcab71": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_5fc6a0404d804d8c935f731e2463416c": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}
{
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 ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
project:
{
Description: The parameters to provide for the created project. ,
Required: True ,
}
{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}
,
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)

{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Projects_Get (updated)
Description :  Returns a Cognitive Services project specified by the parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Projects_Get",
  "$responses": {
    "200": {
      "Description": {
        "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
        "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of Cognitive Services project.",
            "old": "Properties of Cognitive Services account."
          },
          "$properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "Gets the status of the cognitive services project at the time the operation was called.",
                "old": "Gets the status of the cognitive services account at the time the operation was called."
              },
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Moving",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "ResolvingDNS",
                    ""
                  ]
                ]
              }
            },
            {
              "@added_f9e21a7181674a8da9b1325f40dde2e1": {
                "#name": "displayName",
                "Description": "The display name of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_c6a32172dac643ef9d85ef318af9f858": {
                "#name": "description",
                "Description": "The description of the Cognitive Services Project.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_a6512b2ea2cc4af19178539bb6c0036c": {
                "#name": "isDefault",
                "Description": "Indicates whether the project is the default project for the account.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_3f3d16e6641c475e9bf62983afd32b7b": {
                "#name": "endpoint",
                "Description": "Endpoint of the created account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_333681f7b38146d48ec198bc5647ed0a": {
                "#name": "internalId",
                "Description": "The internal identifier (deprecated, do not use this property).",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_1eca1c5e95414108817cbcb452309232": {
                "#name": "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,
                "Type": "array",
                "$items": {
                  "Description": "SkuCapability indicates the capability of a certain feature.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "value",
                      "Description": "The value of the SkuCapability.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_e54edf160de4474bae21a829e4dabf47": {
                "#name": "isMigrated",
                "Description": "If the resource is migrated from an existing key.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_b1e50eecbe9a40bb93a0ebaba8a3a016": {
                "#name": "migrationToken",
                "Description": "Resource migration token.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_aa2234cbc03646dc9c1c0ba31ffc17b5": {
                "#name": "skuChangeInfo",
                "Description": "Sku change info of account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "countOfDowngrades",
                    "Description": "Gets the count of downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "countOfUpgradesAfterDowngrades",
                    "Description": "Gets the count of upgrades after downgrades.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "lastChangeDate",
                    "Description": "Gets the last change date.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_71819a0020c54a66a33022fcfcfe3048": {
                "#name": "customSubDomainName",
                "Description": "Optional subdomain name used for token-based authentication.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_56685e1ed64a4c95947a25264b12014f": {
                "#name": "networkAcls",
                "Description": "A collection of rules governing the accessibility from specific network locations.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "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",
                        ""
                      ],
                      [
                        "Deny",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "bypass",
                    "Description": "Setting for trusted services.",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "AzureServices",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipRules",
                    "Description": "The list of IP address rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "#name": "virtualNetworkRules",
                    "Description": "The list of virtual network rules.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "A rule governing the accessibility from a specific virtual network.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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,
                          "Type": "string"
                        },
                        {
                          "#name": "state",
                          "Description": "Gets the state of virtual network rule.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ignoreMissingVnetServiceEndpoint",
                          "Description": "Ignore missing vnet service endpoint or not.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_5c9ce510f3b24977904f7775418d6a76": {
                "#name": "encryption",
                "Description": "The encryption properties for this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "keyName",
                        "Description": "Name of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVersion",
                        "Description": "Version of the Key from KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "keyVaultUri",
                        "Description": "Uri of KeyVault",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "identityClientId",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.CognitiveServices",
                        ""
                      ],
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_88e8c91b6f88440bbe8722ffc8c7cb6d": {
                "#name": "userOwnedStorage",
                "Description": "The storage accounts for this resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The user owned storage for Cognitive Services account.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "Full resource id of a Microsoft.Storage resource.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "identityClientId",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_a9c864e3b87b4ad39feab90ab02d39fb": {
                "#name": "amlWorkspace",
                "Description": "The user owned AML account properties.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "resourceId",
                    "Description": "Full resource id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "Identity Client id of a AML account resource.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_3b8a0b7b210c4a008d96cdbf8822f483": {
                "#name": "privateEndpointConnections",
                "Description": "The private endpoint connection associated with the Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The Private Endpoint Connection resource.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Resource properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The resource of private end point.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "A collection of information about the state of the connection between service consumer and provider.",
                          "Required": true,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "The reason for approval/rejection of the connection.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "actionsRequired",
                              "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "The provisioning state of the private endpoint connection resource.",
                          "Enum": [
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "groupIds",
                          "Description": "The private link resource group ids.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        }
                      ]
                    },
                    {
                      "#name": "systemData",
                      "Description": "Metadata pertaining to creation and last modification of the resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "createdBy",
                          "Description": "The identity that created the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdByType",
                          "Description": "The type of identity that created the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "createdAt",
                          "Description": "The timestamp of resource creation (UTC).",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedBy",
                          "Description": "The identity that last modified the resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedByType",
                          "Description": "The type of identity that last modified the resource.",
                          "Enum": [
                            [
                              "User",
                              ""
                            ],
                            [
                              "Application",
                              ""
                            ],
                            [
                              "ManagedIdentity",
                              ""
                            ],
                            [
                              "Key",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "lastModifiedAt",
                          "Description": "The timestamp of resource last modification (UTC)",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The location of the private endpoint connection",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_ad4df411dd07487cadf9744c2be0fd54": {
                "#name": "publicNetworkAccess",
                "Description": "Whether or not public endpoint access is allowed for this account.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_517fb86fb9f04830964adb473e0e70d3": {
                "#name": "apiProperties",
                "Description": "The api properties for special APIs.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "qnaRuntimeEndpoint",
                    "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointKey",
                    "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "qnaAzureSearchEndpointId",
                    "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "statisticsEnabled",
                    "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "eventHubConnectionString",
                    "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "storageAccountConnectionString",
                    "Description": "(Personalization Only) The storage account connection string.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadClientId",
                    "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "aadTenantId",
                    "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "superUser",
                    "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "websiteName",
                    "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_338555db36df49c9b689b93ffbf77394": {
                "#name": "dateCreated",
                "Description": "Gets the date of cognitive services account creation.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_9c15611c88a14d3eaf55480b7e88bd76": {
                "#name": "callRateLimit",
                "Description": "The call rate limit Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Description": "The count value of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Description": "The renewal period in seconds of Call Rate Limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_a78934fb15954e2c88893dfd92ad1233": {
                "#name": "dynamicThrottlingEnabled",
                "Description": "The flag to enable dynamic throttling.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_781103ad533246ab803d661a3c18d829": {
                "#name": "quotaLimit",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "count",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "renewalPeriod",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "rules",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "key",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "minCount",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "dynamicThrottlingEnabled",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "matchPatterns",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "path",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "method",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_62001c67979647a497ca952e078fec38": {
                "#name": "restrictOutboundNetworkAccess",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_f479968b3b664e6a8712c5c147f47d9f": {
                "#name": "allowedFqdnList",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@removed_2f4e813da26b444898f5fcbb923c83c6": {
                "#name": "disableLocalAuth",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_a17129804937439ea82f5a106a51385c": {
                "#name": "restore",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@removed_81ff311d20f14c11a67d0ba833c59caf": {
                "#name": "deletionDate",
                "Description": "The deletion date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_23e2a59533fc4da3b48ef372b8e7fb18": {
                "#name": "scheduledPurgeDate",
                "Description": "The scheduled purge date, only available for deleted account.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_2da9c73187a44d7e8c1df4ed405a9299": {
                "#name": "locations",
                "Description": "The multiregion settings of Cognitive Services account.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "routingMethod",
                    "Description": "Multiregion routing methods.",
                    "Enum": [
                      [
                        "Priority",
                        ""
                      ],
                      [
                        "Weighted",
                        ""
                      ],
                      [
                        "Performance",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "regions",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The call rate limit Cognitive Services account.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "name",
                          "Description": "Name of the region.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "value",
                          "Description": "A value for priority or weighted routing methods.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "customsubdomain",
                          "Description": "Maps the region to the regional custom subdomain.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "@removed_bb31a200f8fe4284bcea1189b4fc8579": {
                "#name": "commitmentPlanAssociations",
                "Description": "The commitment plan associations of Cognitive Services account.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The commitment plan association.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "commitmentPlanId",
                      "Description": "The Azure resource id of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commitmentPlanLocation",
                      "Description": "The location of of the commitment plan.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            },
            {
              "@removed_2b6dbf06e6ff494ba7f1429c990cec39": {
                "#name": "abusePenalty",
                "Description": "The abuse penalty.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "action",
                    "Description": "The action of AbusePenalty.",
                    "Enum": [
                      [
                        "Throttle",
                        ""
                      ],
                      [
                        "Block",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "rateLimitPercentage",
                    "Description": "The percentage of rate limit.",
                    "Required": false,
                    "Type": "number"
                  },
                  {
                    "#name": "expiration",
                    "Description": "The datetime of expiration of the AbusePenalty.",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "@removed_101956642b424b27967d73fbfede96e5": {
                "#name": "raiMonitorConfig",
                "Description": "Cognitive Services Rai Monitor Config.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "adxStorageResourceId",
                    "Description": "The storage resource Id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "identityClientId",
                    "Description": "The identity client Id to access the storage.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          ]
        },
        {
          "@removed_5947d3f4ab914bb7806e713fa72d70a6": {
            "#name": "kind",
            "Description": "The Kind of the resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_dbdad04dc3e549d4978d5b6a91dbf782": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "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",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ],
                  [
                    "Enterprise",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "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,
                "Type": "integer"
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}
{
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 ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
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)

{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Projects_List (updated)
Description :  Returns all the projects in a Cognitive Services account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Projects_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "The list of cognitive services projects operation response.",
        "old": "The list of cognitive services accounts operation response."
      },
      "$properties": [
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link used to get the next page of projects.",
            "old": "The link used to get the next page of accounts."
          }
        },
        {
          "#name": "value",
          "Description": {
            "new": "Gets the list of Cognitive Services projects and their properties.",
            "old": "Gets the list of Cognitive Services accounts and their properties."
          },
          "$items": {
            "Description": {
              "new": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.",
              "old": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU."
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Properties of Cognitive Services project.",
                  "old": "Properties of Cognitive Services account."
                },
                "$properties": [
                  {
                    "#name": "provisioningState",
                    "Description": {
                      "new": "Gets the status of the cognitive services project at the time the operation was called.",
                      "old": "Gets the status of the cognitive services account at the time the operation was called."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Accepted",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "ResolvingDNS",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Accepted",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "ResolvingDNS",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "@added_fcb870bcf19840f1860c62b94ac55184": {
                      "#name": "displayName",
                      "Description": "The display name of the Cognitive Services Project.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@added_ae91444a15274032a998ec80c24ee5a7": {
                      "#name": "description",
                      "Description": "The description of the Cognitive Services Project.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@added_7ef523ec36a84cf887a9aef0d42dc214": {
                      "#name": "isDefault",
                      "Description": "Indicates whether the project is the default project for the account.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@removed_bb10d350219943f7b13471cde279b24f": {
                      "#name": "endpoint",
                      "Description": "Endpoint of the created account.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_d5a04ae5c4d94a4ba3104fd8e2e83329": {
                      "#name": "internalId",
                      "Description": "The internal identifier (deprecated, do not use this property).",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_152fe70206dc4ec39fdc421ef277c74e": {
                      "#name": "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,
                      "Type": "array",
                      "$items": {
                        "Description": "SkuCapability indicates the capability of a certain feature.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": "The name of the SkuCapability.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "value",
                            "Description": "The value of the SkuCapability.",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@removed_4262dccaa8ec4d26a461130b960e7f6d": {
                      "#name": "isMigrated",
                      "Description": "If the resource is migrated from an existing key.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@removed_693a1a882c474b1885b184cd0b2b03a4": {
                      "#name": "migrationToken",
                      "Description": "Resource migration token.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_714f6837d88e464d8a401361799100e2": {
                      "#name": "skuChangeInfo",
                      "Description": "Sku change info of account.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "countOfDowngrades",
                          "Description": "Gets the count of downgrades.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "countOfUpgradesAfterDowngrades",
                          "Description": "Gets the count of upgrades after downgrades.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "lastChangeDate",
                          "Description": "Gets the last change date.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_d25d561241d04836a46eb52f7e905b3b": {
                      "#name": "customSubDomainName",
                      "Description": "Optional subdomain name used for token-based authentication.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_48cd1c2599ff49d3a57c2dbea7db7f86": {
                      "#name": "networkAcls",
                      "Description": "A collection of rules governing the accessibility from specific network locations.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "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",
                              ""
                            ],
                            [
                              "Deny",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "bypass",
                          "Description": "Setting for trusted services.",
                          "Enum": [
                            [
                              "None",
                              ""
                            ],
                            [
                              "AzureServices",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "ipRules",
                          "Description": "The list of IP address rules.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "A rule governing the accessibility from a specific ip address or ip range.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "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,
                                "Type": "string"
                              }
                            ]
                          }
                        },
                        {
                          "#name": "virtualNetworkRules",
                          "Description": "The list of virtual network rules.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "A rule governing the accessibility from a specific virtual network.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "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,
                                "Type": "string"
                              },
                              {
                                "#name": "state",
                                "Description": "Gets the state of virtual network rule.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ignoreMissingVnetServiceEndpoint",
                                "Description": "Ignore missing vnet service endpoint or not.",
                                "Required": false,
                                "Type": "boolean"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_17b9710dd6584fd6b3e85764ed3be986": {
                      "#name": "encryption",
                      "Description": "The encryption properties for this resource.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyVaultProperties",
                          "Description": "Properties of KeyVault",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "keyName",
                              "Description": "Name of the Key from KeyVault",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "keyVersion",
                              "Description": "Version of the Key from KeyVault",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "keyVaultUri",
                              "Description": "Uri of KeyVault",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "identityClientId",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "keySource",
                          "Description": "Enumerates the possible value of keySource for Encryption",
                          "Enum": [
                            [
                              "Microsoft.CognitiveServices",
                              ""
                            ],
                            [
                              "Microsoft.KeyVault",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_5368cc130d4d49b48952b745dd15a5f6": {
                      "#name": "userOwnedStorage",
                      "Description": "The storage accounts for this resource.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The user owned storage for Cognitive Services account.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "resourceId",
                            "Description": "Full resource id of a Microsoft.Storage resource.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "identityClientId",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@removed_7064dbd6489d4ebdb2cc08104cde2c25": {
                      "#name": "amlWorkspace",
                      "Description": "The user owned AML account properties.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "resourceId",
                          "Description": "Full resource id of a AML account resource.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "identityClientId",
                          "Description": "Identity Client id of a AML account resource.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_baeffa8d65574c0784f04a5a2b14eb15": {
                      "#name": "privateEndpointConnections",
                      "Description": "The private endpoint connection associated with the Cognitive Services account.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The Private Endpoint Connection resource.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "properties",
                            "Description": "Resource properties.",
                            "Required": false,
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "privateEndpoint",
                                "Description": "The resource of private end point.",
                                "Required": false,
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "id",
                                    "Description": "The ARM identifier for Private Endpoint",
                                    "Required": false,
                                    "Type": "string"
                                  }
                                ]
                              },
                              {
                                "#name": "privateLinkServiceConnectionState",
                                "Description": "A collection of information about the state of the connection between service consumer and provider.",
                                "Required": true,
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "status",
                                    "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                                    "Enum": [
                                      [
                                        "Pending",
                                        ""
                                      ],
                                      [
                                        "Approved",
                                        ""
                                      ],
                                      [
                                        "Rejected",
                                        ""
                                      ]
                                    ],
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "description",
                                    "Description": "The reason for approval/rejection of the connection.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "actionsRequired",
                                    "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                                    "Required": false,
                                    "Type": "string"
                                  }
                                ]
                              },
                              {
                                "#name": "provisioningState",
                                "Description": "The provisioning state of the private endpoint connection resource.",
                                "Enum": [
                                  [
                                    "Succeeded",
                                    ""
                                  ],
                                  [
                                    "Creating",
                                    ""
                                  ],
                                  [
                                    "Deleting",
                                    ""
                                  ],
                                  [
                                    "Failed",
                                    ""
                                  ]
                                ],
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "groupIds",
                                "Description": "The private link resource group ids.",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              }
                            ]
                          },
                          {
                            "#name": "systemData",
                            "Description": "Metadata pertaining to creation and last modification of the resource.",
                            "Required": false,
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "createdBy",
                                "Description": "The identity that created the resource.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "createdByType",
                                "Description": "The type of identity that created the resource.",
                                "Enum": [
                                  [
                                    "User",
                                    ""
                                  ],
                                  [
                                    "Application",
                                    ""
                                  ],
                                  [
                                    "ManagedIdentity",
                                    ""
                                  ],
                                  [
                                    "Key",
                                    ""
                                  ]
                                ],
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "createdAt",
                                "Description": "The timestamp of resource creation (UTC).",
                                "Format": "date-time",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "lastModifiedBy",
                                "Description": "The identity that last modified the resource.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "lastModifiedByType",
                                "Description": "The type of identity that last modified the resource.",
                                "Enum": [
                                  [
                                    "User",
                                    ""
                                  ],
                                  [
                                    "Application",
                                    ""
                                  ],
                                  [
                                    "ManagedIdentity",
                                    ""
                                  ],
                                  [
                                    "Key",
                                    ""
                                  ]
                                ],
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "lastModifiedAt",
                                "Description": "The timestamp of resource last modification (UTC)",
                                "Format": "date-time",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          },
                          {
                            "#name": "location",
                            "Description": "The location of the private endpoint connection",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@removed_2786e30040d5487f9aca6fdb3b65b9ec": {
                      "#name": "publicNetworkAccess",
                      "Description": "Whether or not public endpoint access is allowed for this account.",
                      "Enum": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_a7d61c9af82e4c38890b6d3aa6d08707": {
                      "#name": "apiProperties",
                      "Description": "The api properties for special APIs.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "qnaRuntimeEndpoint",
                          "Description": "(QnAMaker Only) The runtime endpoint of QnAMaker.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "qnaAzureSearchEndpointKey",
                          "Description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "qnaAzureSearchEndpointId",
                          "Description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "statisticsEnabled",
                          "Description": "(Bing Search Only) The flag to enable statistics of Bing Search.",
                          "Required": false,
                          "Type": "boolean"
                        },
                        {
                          "#name": "eventHubConnectionString",
                          "Description": "(Personalization Only) The flag to enable statistics of Bing Search.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "storageAccountConnectionString",
                          "Description": "(Personalization Only) The storage account connection string.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "aadClientId",
                          "Description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "aadTenantId",
                          "Description": "(Metrics Advisor Only) The Azure AD Tenant Id.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "superUser",
                          "Description": "(Metrics Advisor Only) The super user of Metrics Advisor.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "websiteName",
                          "Description": "(Metrics Advisor Only) The website name of Metrics Advisor.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_24576bb28ab740499897ec9dbf69cf5b": {
                      "#name": "dateCreated",
                      "Description": "Gets the date of cognitive services account creation.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_c791c6cf0b5f4872a7a8e04d36956442": {
                      "#name": "callRateLimit",
                      "Description": "The call rate limit Cognitive Services account.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "count",
                          "Description": "The count value of Call Rate Limit.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Description": "The renewal period in seconds of Call Rate Limit.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "rules",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "key",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "renewalPeriod",
                                "Required": false,
                                "Type": "number"
                              },
                              {
                                "#name": "count",
                                "Required": false,
                                "Type": "number"
                              },
                              {
                                "#name": "minCount",
                                "Required": false,
                                "Type": "number"
                              },
                              {
                                "#name": "dynamicThrottlingEnabled",
                                "Required": false,
                                "Type": "boolean"
                              },
                              {
                                "#name": "matchPatterns",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "path",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "method",
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_b5ae16ac72854f18a816cd68829d287b": {
                      "#name": "dynamicThrottlingEnabled",
                      "Description": "The flag to enable dynamic throttling.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@removed_e9495869460b4e76b2d024377550c234": {
                      "#name": "quotaLimit",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "count",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "renewalPeriod",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "rules",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "key",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "renewalPeriod",
                                "Required": false,
                                "Type": "number"
                              },
                              {
                                "#name": "count",
                                "Required": false,
                                "Type": "number"
                              },
                              {
                                "#name": "minCount",
                                "Required": false,
                                "Type": "number"
                              },
                              {
                                "#name": "dynamicThrottlingEnabled",
                                "Required": false,
                                "Type": "boolean"
                              },
                              {
                                "#name": "matchPatterns",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "path",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "method",
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_d1e2fdcf1a284d14be205d8d22579dea": {
                      "#name": "restrictOutboundNetworkAccess",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@removed_a8ae6b50519843ceaf242efd35390e48": {
                      "#name": "allowedFqdnList",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    }
                  },
                  {
                    "@removed_cd9b156d32794c38b5269d7647759f2c": {
                      "#name": "disableLocalAuth",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@removed_8d8e5fa25f7142b585d293ebf1452d5c": {
                      "#name": "restore",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@removed_100b4a58684a4ec5bd53ae3678bf3dd8": {
                      "#name": "deletionDate",
                      "Description": "The deletion date, only available for deleted account.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_783ce8e332444cba849bff1556f33fcb": {
                      "#name": "scheduledPurgeDate",
                      "Description": "The scheduled purge date, only available for deleted account.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_ee27f307dc01447180dd1c93ed8e0172": {
                      "#name": "locations",
                      "Description": "The multiregion settings of Cognitive Services account.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "routingMethod",
                          "Description": "Multiregion routing methods.",
                          "Enum": [
                            [
                              "Priority",
                              ""
                            ],
                            [
                              "Weighted",
                              ""
                            ],
                            [
                              "Performance",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "regions",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The call rate limit Cognitive Services account.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "name",
                                "Description": "Name of the region.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "value",
                                "Description": "A value for priority or weighted routing methods.",
                                "Required": false,
                                "Type": "number"
                              },
                              {
                                "#name": "customsubdomain",
                                "Description": "Maps the region to the regional custom subdomain.",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_f86c29bcae7c4b6bbe79f94078550c1d": {
                      "#name": "commitmentPlanAssociations",
                      "Description": "The commitment plan associations of Cognitive Services account.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The commitment plan association.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "commitmentPlanId",
                            "Description": "The Azure resource id of the commitment plan.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "commitmentPlanLocation",
                            "Description": "The location of of the commitment plan.",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@removed_9c51282cca4a47d6bccc0b6a9852b308": {
                      "#name": "abusePenalty",
                      "Description": "The abuse penalty.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "action",
                          "Description": "The action of AbusePenalty.",
                          "Enum": [
                            [
                              "Throttle",
                              ""
                            ],
                            [
                              "Block",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "rateLimitPercentage",
                          "Description": "The percentage of rate limit.",
                          "Required": false,
                          "Type": "number"
                        },
                        {
                          "#name": "expiration",
                          "Description": "The datetime of expiration of the AbusePenalty.",
                          "Format": "date-time",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_66b8a80a973645d9b8efb9472c9a10b7": {
                      "#name": "raiMonitorConfig",
                      "Description": "Cognitive Services Rai Monitor Config.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "adxStorageResourceId",
                          "Description": "The storage resource Id.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "identityClientId",
                          "Description": "The identity client Id to access the storage.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "@removed_efd1d71bd14e4f2e88104ba2da6911e1": {
                  "#name": "kind",
                  "Description": "The Kind of the resource.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_74022739854c40ec91cb4b0b35f6679a": {
                  "#name": "sku",
                  "Description": "The resource model definition representing SKU",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The name of the SKU. Ex - P3. It is typically a letter+number code",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "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",
                          ""
                        ],
                        [
                          "Basic",
                          ""
                        ],
                        [
                          "Standard",
                          ""
                        ],
                        [
                          "Premium",
                          ""
                        ],
                        [
                          "Enterprise",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "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,
                      "Type": "string"
                    },
                    {
                      "#name": "family",
                      "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "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,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects
{
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)

{
nextLink:
{
Description: The link used to get the next page of projects. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of Cognitive Services projects and their properties. ,
Required: False ,
}
[
{
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 project. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the cognitive services project 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. ,
Canceled: No description available. ,
ResolvingDNS: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the Cognitive Services Project. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Cognitive Services Project. ,
Required: False ,
}
string ,
endpoints:
{
Description: The list of endpoint for this Cognitive Services Project. ,
Required: False ,
}
object ,
isDefault:
{
Description: Indicates whether the project is the default project for the account. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}