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

2025/03/18 • 97 new methods

Accounts_Create (new)
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 ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
{
resourceGroupName: string ,
accountName: string ,
account:
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (201)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (202)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
{
resourceGroupName: string ,
accountName: string ,
account:
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (202)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_Delete (new)
Description Deletes a Cognitive Services account from the resource group.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/resourceGroups/{resourceGroupName}/deletedAccounts/{accountName}
{
location: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
DeletedAccounts_Purge (new)
Description Deletes a Cognitive Services account from the resource group.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/resourceGroups/{resourceGroupName}/deletedAccounts/{accountName}
{
location: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts
{
resourceGroupName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/deletedAccounts
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_ListKeys (new)
Description Lists the account keys for the specified Cognitive Services account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
key1: string ,
key2: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_RegenerateKey (new)
Description Regenerates the specified account key for the specified Cognitive Services account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey
{
resourceGroupName: string ,
accountName: string ,
parameters:
{
keyName: enum ,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
key1: string ,
key2: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ResourceSkus_List (new)
Description Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/skus
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
resourceType: string ,
name: string ,
tier: string ,
kind: string ,
locations:
[
string ,
]
,
restrictions:
[
{
type: enum ,
values:
[
string ,
]
,
restrictionInfo:
{
locations:
[
string ,
]
,
zones:
[
string ,
]
,
}
,
reasonCode: enum ,
}
,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_ListSkus (new)
Description List available SKUs for the requested Cognitive Services account
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/skus
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
resourceType: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Usages_List (new)
Description Get usages for the requested subscription
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages
{
subscriptionId: string ,
api-version: string ,
location: string ,
$filter: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
quotaPeriod: string ,
limit: number ,
currentValue: number ,
nextResetTime: string ,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_ListUsages (new)
Description Get usages for the requested Cognitive Services account
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
$filter: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
quotaPeriod: string ,
limit: number ,
currentValue: number ,
nextResetTime: string ,
status: enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_ListModels (new)
Description List available Models for the requested Cognitive Services account
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/models
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
baseModel:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
isDefaultVersion: boolean ,
skus:
[
{
name: string ,
usageName: string ,
deprecationDate: string ,
capacity:
{
minimum: integer ,
maximum: integer ,
step: integer ,
default: integer ,
allowedValues:
[
integer ,
]
,
}
,
rateLimits:
[
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
]
,
cost:
[
{
name: string ,
meterId: string ,
unit: string ,
}
,
]
,
}
,
]
,
maxCapacity: integer ,
capabilities: object ,
finetuneCapabilities: object ,
deprecation:
{
fineTune: string ,
inference: string ,
}
,
lifecycleStatus: enum ,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Operations_List (new)
Description Lists all the available Cognitive Services account operations.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.CognitiveServices/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
isDataAction: boolean ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
origin: enum ,
actionType: enum ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CheckSkuAvailability (new)
Description Check available SKUs.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability
{
subscriptionId: string ,
api-version: string ,
location: string ,
parameters:
{
skus:
[
string ,
]
,
kind: string ,
type: string ,
}
,
}

⚐ Response (200)

{
value:
[
{
kind: string ,
type: string ,
skuName: string ,
skuAvailable: boolean ,
reason: string ,
message: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentTiers_List (new)
Description List Commitment Tiers.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/commitmentTiers
{
subscriptionId: string ,
api-version: string ,
location: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
kind: string ,
skuName: string ,
hostingModel: enum ,
planType: string ,
tier: string ,
maxCount: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
cost:
{
commitmentMeterId: string ,
overageMeterId: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Models_List (new)
Description List Models.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/models
{
subscriptionId: string ,
api-version: string ,
location: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
model:
{
baseModel:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
isDefaultVersion: boolean ,
skus:
[
{
name: string ,
usageName: string ,
deprecationDate: string ,
capacity:
{
minimum: integer ,
maximum: integer ,
step: integer ,
default: integer ,
allowedValues:
[
integer ,
]
,
}
,
rateLimits:
[
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
]
,
cost:
[
{
name: string ,
meterId: string ,
unit: string ,
}
,
]
,
}
,
]
,
maxCapacity: integer ,
capabilities: object ,
finetuneCapabilities: object ,
deprecation:
{
fineTune: string ,
inference: string ,
}
,
lifecycleStatus: enum ,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
kind: string ,
skuName: string ,
description: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LocationBasedModelCapacities_List (new)
Description List Location Based ModelCapacities.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/modelCapacities
{
subscriptionId: string ,
api-version: string ,
location: string ,
modelFormat: string ,
modelName: string ,
modelVersion: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
location: string ,
properties:
{
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
skuName: string ,
availableCapacity: number ,
availableFinetuneCapacity: number ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ModelCapacities_List (new)
Description List ModelCapacities.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/modelCapacities
{
subscriptionId: string ,
api-version: string ,
modelFormat: string ,
modelName: string ,
modelVersion: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
location: string ,
properties:
{
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
skuName: string ,
availableCapacity: number ,
availableFinetuneCapacity: number ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CheckDomainAvailability (new)
Description Check whether a domain is available.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability
{
subscriptionId: string ,
api-version: string ,
parameters:
{
subdomainName: string ,
type: string ,
kind: string ,
}
,
}

⚐ Response (200)

{
isSubdomainAvailable: boolean ,
reason: string ,
subdomainName: string ,
type: string ,
kind: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
calculateModelCapacity (new)
Description Model capacity calculator.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/calculateModelCapacity
{
subscriptionId: string ,
api-version: string ,
parameters:
{
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
skuName: string ,
workloads:
[
{
requestPerMinute: integer ,
requestParameters:
{
avgPromptTokens: integer ,
avgGeneratedTokens: integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
skuName: string ,
estimatedCapacity:
{
value: integer ,
deployableValue: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description Gets the private endpoint connections associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description Gets the specified private endpoint connection associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description Update the state of specified private endpoint connection associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
privateEndpointConnectionName: string ,
properties:
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}

⚐ Response (202)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description Deletes the specified private endpoint connection associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateLinkResources_List (new)
Description Gets the private link resources that need to be created for a Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateLinkResources
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
displayName: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_List (new)
Description Gets the deployments associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
scaleType: enum ,
capacity: integer ,
activeCapacity: integer ,
}
,
capabilities: object ,
raiPolicyName: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
versionUpgradeOption: enum ,
dynamicThrottlingEnabled: boolean ,
currentCapacity: integer ,
capacitySettings:
{
designatedCapacity: integer ,
priority: integer ,
}
,
parentDeploymentName: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_Get (new)
Description Gets the specified deployments associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
deploymentName: string ,
}

⚐ Response (200)

{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
scaleType: enum ,
capacity: integer ,
activeCapacity: integer ,
}
,
capabilities: object ,
raiPolicyName: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
versionUpgradeOption: enum ,
dynamicThrottlingEnabled: boolean ,
currentCapacity: integer ,
capacitySettings:
{
designatedCapacity: integer ,
priority: integer ,
}
,
parentDeploymentName: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdate (new)
Description Update the state of specified deployments associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
deploymentName: string ,
deployment:
{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
scaleType: enum ,
capacity: integer ,
activeCapacity: integer ,
}
,
capabilities: object ,
raiPolicyName: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
versionUpgradeOption: enum ,
dynamicThrottlingEnabled: boolean ,
currentCapacity: integer ,
capacitySettings:
{
designatedCapacity: integer ,
priority: integer ,
}
,
parentDeploymentName: string ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
scaleType: enum ,
capacity: integer ,
activeCapacity: integer ,
}
,
capabilities: object ,
raiPolicyName: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
versionUpgradeOption: enum ,
dynamicThrottlingEnabled: boolean ,
currentCapacity: integer ,
capacitySettings:
{
designatedCapacity: integer ,
priority: integer ,
}
,
parentDeploymentName: string ,
}
,
}

⚐ Response (201)

{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
scaleType: enum ,
capacity: integer ,
activeCapacity: integer ,
}
,
capabilities: object ,
raiPolicyName: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
versionUpgradeOption: enum ,
dynamicThrottlingEnabled: boolean ,
currentCapacity: integer ,
capacitySettings:
{
designatedCapacity: integer ,
priority: integer ,
}
,
parentDeploymentName: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_Update (new)
Description Update specified deployments associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
deploymentName: string ,
deployment:
{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
model:
{
publisher: string ,
format: string ,
name: string ,
version: string ,
source: string ,
sourceAccount: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
}
,
scaleSettings:
{
scaleType: enum ,
capacity: integer ,
activeCapacity: integer ,
}
,
capabilities: object ,
raiPolicyName: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
rateLimits:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
versionUpgradeOption: enum ,
dynamicThrottlingEnabled: boolean ,
currentCapacity: integer ,
capacitySettings:
{
designatedCapacity: integer ,
priority: integer ,
}
,
parentDeploymentName: string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_Delete (new)
Description Deletes the specified deployment associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
deploymentName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_ListSkus (new)
Description Lists the specified deployments skus associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/skus
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
deploymentName: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
resourceType: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
capacity:
{
minimum: integer ,
maximum: integer ,
step: integer ,
default: integer ,
allowedValues:
[
integer ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_List (new)
Description Gets the commitmentPlans associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_Get (new)
Description Gets the specified commitmentPlans associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
commitmentPlanName: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_CreateOrUpdate (new)
Description Update the state of specified commitmentPlans associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
commitmentPlanName: string ,
commitmentPlan:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_Delete (new)
Description Deletes the specified commitmentPlan associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
commitmentPlanName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
EncryptionScopes_List (new)
Description Gets the content filters associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
state: enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
EncryptionScopes_Get (new)
Description Gets the specified EncryptionScope associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
encryptionScopeName: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
state: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
EncryptionScopes_CreateOrUpdate (new)
Description Update the state of specified encryptionScope associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
encryptionScopeName: string ,
encryptionScope:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
state: enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
state: enum ,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
provisioningState: enum ,
state: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
EncryptionScopes_Delete (new)
Description Deletes the specified encryptionScope associated with the Cognitive Services account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
encryptionScopeName: string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiPolicies_List (new)
Description Gets the content filters associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
type: enum ,
mode: enum ,
basePolicyName: string ,
contentFilters:
[
{
name: string ,
enabled: boolean ,
severityThreshold: enum ,
blocking: boolean ,
source: enum ,
}
,
]
,
customBlocklists:
[
{
source: enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklists_List (new)
Description Gets the custom blocklists associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
description: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklistItems_List (new)
Description Gets the blocklist items associated with the custom blocklist.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
pattern: string ,
isRegex: boolean ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiPolicies_Get (new)
Description Gets the specified Content Filters associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiPolicyName: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
type: enum ,
mode: enum ,
basePolicyName: string ,
contentFilters:
[
{
name: string ,
enabled: boolean ,
severityThreshold: enum ,
blocking: boolean ,
source: enum ,
}
,
]
,
customBlocklists:
[
{
source: enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiPolicies_CreateOrUpdate (new)
Description Update the state of specified Content Filters associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiPolicyName: string ,
raiPolicy:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
type: enum ,
mode: enum ,
basePolicyName: string ,
contentFilters:
[
{
name: string ,
enabled: boolean ,
severityThreshold: enum ,
blocking: boolean ,
source: enum ,
}
,
]
,
customBlocklists:
[
{
source: enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
type: enum ,
mode: enum ,
basePolicyName: string ,
contentFilters:
[
{
name: string ,
enabled: boolean ,
severityThreshold: enum ,
blocking: boolean ,
source: enum ,
}
,
]
,
customBlocklists:
[
{
source: enum ,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
type: enum ,
mode: enum ,
basePolicyName: string ,
contentFilters:
[
{
name: string ,
enabled: boolean ,
severityThreshold: enum ,
blocking: boolean ,
source: enum ,
}
,
]
,
customBlocklists:
[
{
source: enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiPolicies_Delete (new)
Description Deletes the specified Content Filters associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiPolicyName: string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklists_Get (new)
Description Gets the specified custom blocklist associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
description: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklists_CreateOrUpdate (new)
Description Update the state of specified blocklist associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
raiBlocklist:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
description: string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
description: string ,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
description: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklists_Delete (new)
Description Deletes the specified custom blocklist associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklistItems_Get (new)
Description Gets the specified custom blocklist Item associated with the custom blocklist.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
raiBlocklistItemName: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
pattern: string ,
isRegex: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklistItems_CreateOrUpdate (new)
Description Update the state of specified blocklist item associated with the Azure OpenAI account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
raiBlocklistItemName: string ,
raiBlocklistItem:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
pattern: string ,
isRegex: boolean ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
pattern: string ,
isRegex: boolean ,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
pattern: string ,
isRegex: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklistItems_Delete (new)
Description Deletes the specified blocklist Item associated with the custom blocklist.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
raiBlocklistItemName: string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklistItems_BatchAdd (new)
Description Batch operation to add blocklist items.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/addRaiBlocklistItems
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
raiBlocklistItems:
{
name: string ,
properties:
{
pattern: string ,
isRegex: boolean ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
description: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiBlocklistItems_BatchDelete (new)
Description Batch operation to delete blocklist items.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/deleteRaiBlocklistItems
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
raiBlocklistName: string ,
raiBlocklistItemsNames: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiContentFilters_List (new)
Description List Content Filters types.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters
{
subscriptionId: string ,
api-version: string ,
location: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
properties:
{
name: string ,
isMultiLevelFilter: boolean ,
source: enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RaiContentFilters_Get (new)
Description Get Content Filters by Name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters/{filterName}
{
subscriptionId: string ,
api-version: string ,
location: string ,
filterName: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
isMultiLevelFilter: boolean ,
source: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_CreateOrUpdatePlan (new)
Description Create Cognitive Services commitment plan.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}
{
resourceGroupName: string ,
commitmentPlanName: string ,
commitmentPlan:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_UpdatePlan (new)
Description Create Cognitive Services commitment plan.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}
{
resourceGroupName: string ,
commitmentPlanName: string ,
commitmentPlan:
{
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_DeletePlan (new)
Description Deletes a Cognitive Services commitment plan from the resource group.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}
{
resourceGroupName: string ,
commitmentPlanName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_GetPlan (new)
Description Returns a Cognitive Services commitment plan specified by the parameters.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}
{
resourceGroupName: string ,
commitmentPlanName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_ListPlansByResourceGroup (new)
Description Returns all the resources of a particular type belonging to a resource group
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans
{
resourceGroupName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/commitmentPlans
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
commitmentPlanGuid: string ,
hostingModel: enum ,
planType: string ,
current:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
autoRenew: boolean ,
next:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
last:
{
tier: string ,
count: integer ,
quota:
{
quantity: integer ,
unit: string ,
}
,
startDate: string ,
endDate: string ,
}
,
provisioningIssues:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_ListAssociations (new)
Description Gets the associations of the Cognitive Services commitment plan.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
commitmentPlanName: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
accountId: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_GetAssociation (new)
Description Gets the association of the Cognitive Services commitment plan.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations/{commitmentPlanAssociationName}
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
commitmentPlanName: string ,
commitmentPlanAssociationName: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
accountId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_CreateOrUpdateAssociation (new)
Description Create or update the association of the Cognitive Services commitment plan.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations/{commitmentPlanAssociationName}
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
commitmentPlanName: string ,
commitmentPlanAssociationName: string ,
association:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
accountId: string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
accountId: string ,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
accountId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CommitmentPlans_DeleteAssociation (new)
Description Deletes the association of the Cognitive Services commitment plan.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations/{commitmentPlanAssociationName}
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
commitmentPlanName: string ,
commitmentPlanAssociationName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_List (new)
Description Gets a list of NSP configurations for an account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: string ,
provisioningIssues:
[
{
name: string ,
properties:
{
issueType: string ,
severity: string ,
description: string ,
suggestedResourceIds:
[
string ,
]
,
suggestedAccessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
resourceAssociation:
{
name: string ,
accessMode: string ,
}
,
profile:
{
name: string ,
accessRulesVersion: integer ,
accessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion: integer ,
enabledLogCategories:
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Get (new)
Description Gets the specified NSP configurations for an account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
nspConfigurationName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: string ,
provisioningIssues:
[
{
name: string ,
properties:
{
issueType: string ,
severity: string ,
description: string ,
suggestedResourceIds:
[
string ,
]
,
suggestedAccessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
resourceAssociation:
{
name: string ,
accessMode: string ,
}
,
profile:
{
name: string ,
accessRulesVersion: integer ,
accessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion: integer ,
enabledLogCategories:
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Reconcile (new)
Description Reconcile the NSP configuration for an account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}/reconcile
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
nspConfigurationName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: string ,
provisioningIssues:
[
{
name: string ,
properties:
{
issueType: string ,
severity: string ,
description: string ,
suggestedResourceIds:
[
string ,
]
,
suggestedAccessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
resourceAssociation:
{
name: string ,
accessMode: string ,
}
,
profile:
{
name: string ,
accessRulesVersion: integer ,
accessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion: integer ,
enabledLogCategories:
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
DefenderForAISettings_List (new)
Description Lists the Defender for AI settings.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
state: enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
DefenderForAISettings_Get (new)
Description Gets the specified Defender for AI setting by name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings/{defenderForAISettingName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
defenderForAISettingName: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
state: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
DefenderForAISettings_CreateOrUpdate (new)
Description Creates or Updates the specified Defender for AI setting.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings/{defenderForAISettingName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
defenderForAISettingName: string ,
defenderForAISettings:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
state: enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
state: enum ,
}
,
}

⚐ Response (201)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
state: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
DefenderForAISettings_Update (new)
Description Updates the specified Defender for AI setting.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings/{defenderForAISettingName}
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
defenderForAISettingName: string ,
defenderForAISettings:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
state: enum ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
etag: string ,
tags: object ,
properties:
{
state: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Projects_Create (new)
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 ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}
{
resourceGroupName: string ,
accountName: string ,
projectName: string ,
project:
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (201)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (202)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Projects_Update (new)
Description Updates a Cognitive Services Project
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}
{
resourceGroupName: string ,
accountName: string ,
projectName: string ,
project:
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (202)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Projects_Delete (new)
Description Deletes a Cognitive Services project from the resource group.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}
{
resourceGroupName: string ,
accountName: string ,
projectName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Projects_Get (new)
Description Returns a Cognitive Services project specified by the parameters.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}
{
resourceGroupName: string ,
accountName: string ,
projectName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Projects_List (new)
Description Returns all the projects in a Cognitive Services account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects
{
resourceGroupName: string ,
accountName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
kind: string ,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
properties:
{
provisioningState: enum ,
endpoint: string ,
internalId: string ,
capabilities:
[
{
name: string ,
value: string ,
}
,
]
,
isMigrated: boolean ,
migrationToken: string ,
skuChangeInfo:
{
countOfDowngrades: number ,
countOfUpgradesAfterDowngrades: number ,
lastChangeDate: string ,
}
,
customSubDomainName: string ,
networkAcls:
{
defaultAction: enum ,
bypass: enum ,
ipRules:
[
{
value: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
state: string ,
ignoreMissingVnetServiceEndpoint: boolean ,
}
,
]
,
}
,
encryption:
{
keyVaultProperties:
{
keyName: string ,
keyVersion: string ,
keyVaultUri: string ,
identityClientId: string ,
}
,
keySource: enum ,
}
,
userOwnedStorage:
[
{
resourceId: string ,
identityClientId: string ,
}
,
]
,
amlWorkspace:
{
resourceId: string ,
identityClientId: string ,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
groupIds:
[
string ,
]
,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
location: string ,
}
,
]
,
publicNetworkAccess: enum ,
apiProperties:
{
qnaRuntimeEndpoint: string ,
qnaAzureSearchEndpointKey: string ,
qnaAzureSearchEndpointId: string ,
statisticsEnabled: boolean ,
eventHubConnectionString: string ,
storageAccountConnectionString: string ,
aadClientId: string ,
aadTenantId: string ,
superUser: string ,
websiteName: string ,
}
,
dateCreated: string ,
callRateLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
dynamicThrottlingEnabled: boolean ,
quotaLimit:
{
count: number ,
renewalPeriod: number ,
rules:
[
{
key: string ,
renewalPeriod: number ,
count: number ,
minCount: number ,
dynamicThrottlingEnabled: boolean ,
matchPatterns:
[
{
path: string ,
method: string ,
}
,
]
,
}
,
]
,
}
,
restrictOutboundNetworkAccess: boolean ,
allowedFqdnList:
[
string ,
]
,
disableLocalAuth: boolean ,
endpoints: object ,
restore: boolean ,
deletionDate: string ,
scheduledPurgeDate: string ,
locations:
{
routingMethod: enum ,
regions:
[
{
name: string ,
value: number ,
customsubdomain: string ,
}
,
]
,
}
,
commitmentPlanAssociations:
[
{
commitmentPlanId: string ,
commitmentPlanLocation: string ,
}
,
]
,
abusePenalty:
{
action: enum ,
rateLimitPercentage: number ,
expiration: string ,
}
,
raiMonitorConfig:
{
adxStorageResourceId: string ,
identityClientId: string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountConnection_Delete (new)
Description Delete Cognitive Services account connection by name.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
connectionName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountConnection_Get (new)
Description Lists Cognitive Services account connection by name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
connectionName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountConnection_Update (new)
Description Update Cognitive Services account connection under the specified account.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
connectionName: string ,
api-version: string ,
body:
{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountConnection_Create (new)
Description Create or update Cognitive Services account connection under the specified account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
connectionName: string ,
api-version: string ,
body:
{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountConnection_List (new)
Description Lists all the available Cognitive Services account connections under the specified account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
target: string ,
category: string ,
api-version: string ,
includeAll: boolean ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectConnection_Delete (new)
Description Delete Cognitive Services project connection by name.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
connectionName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectConnection_Get (new)
Description Lists Cognitive Services project connection by name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
connectionName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectConnection_Update (new)
Description Update Cognitive Services project connection under the specified project.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
connectionName: string ,
api-version: string ,
body:
{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectConnection_Create (new)
Description Create or update Cognitive Services project connection under the specified project.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
connectionName: string ,
api-version: string ,
body:
{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectConnection_List (new)
Description Lists all the available Cognitive Services project connections under the specified project.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
target: string ,
category: string ,
api-version: string ,
includeAll: boolean ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
properties:
{
authType: enum ,
category: enum ,
createdByWorkspaceArmId: string ,
error: string ,
expiryTime: string ,
group: enum ,
isSharedToAll: boolean ,
metadata: object ,
peRequirement: enum ,
peStatus: enum ,
sharedUserList:
[
string ,
]
,
target: string ,
useWorkspaceManagedIdentity: boolean ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountCapabilityHosts_Delete (new)
Description Delete account capabilityHost.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts/{capabilityHostName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
capabilityHostName: string ,
api-version: string ,
}

⚐ Response (202)

{
x-ms-async-operation-timeout: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountCapabilityHosts_Get (new)
Description Get account capabilityHost.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts/{capabilityHostName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
capabilityHostName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AccountCapabilityHosts_CreateOrUpdate (new)
Description Create or update account capabilityHost.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts/{capabilityHostName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
capabilityHostName: string ,
api-version: string ,
body:
{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout: string ,
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectCapabilityHosts_Delete (new)
Description Delete project capabilityHost.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts/{capabilityHostName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
capabilityHostName: string ,
api-version: string ,
}

⚐ Response (202)

{
x-ms-async-operation-timeout: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectCapabilityHosts_Get (new)
Description Get project capabilityHost.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts/{capabilityHostName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
capabilityHostName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ProjectCapabilityHosts_CreateOrUpdate (new)
Description Create or update project capabilityHost.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts/{capabilityHostName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
projectName: string ,
capabilityHostName: string ,
api-version: string ,
body:
{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout: string ,
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
aiServicesConnections:
[
string ,
]
,
capabilityHostKind: enum ,
customerSubnet: string ,
provisioningState: enum ,
storageConnections:
[
string ,
]
,
threadStorageConnections:
[
string ,
]
,
vectorStoreConnections:
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}