diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/cspell.yaml b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/cspell.yaml index 3be7b4acd62b..02b3174e56d5 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/cspell.yaml +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/cspell.yaml @@ -2,6 +2,7 @@ import: - ../../../../cspell.yaml words: - ADLS + - agentic - Eloqua - Hdfs - Informix diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json new file mode 100644 index 000000000000..4a288c941f6e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json @@ -0,0 +1,11873 @@ +{ + "swagger": "2.0", + "info": { + "title": "CognitiveServicesManagementClient", + "description": "Cognitive Services Management Client", + "version": "2025-10-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}": { + "put": { + "tags": [ + "CognitiveServicesAccounts" + ], + "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.", + "operationId": "Accounts_Create", + "x-ms-examples": { + "Create Account": { + "$ref": "./examples/CreateAccount.json" + }, + "Create Account Min": { + "$ref": "./examples/CreateAccountMin.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "account", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Updates a Cognitive Services account", + "operationId": "Accounts_Update", + "x-ms-examples": { + "Update Account": { + "$ref": "./examples/UpdateAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "account", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group. ", + "operationId": "Accounts_Delete", + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/DeleteAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "operationId": "Accounts_Get", + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/resourceGroups/{resourceGroupName}/deletedAccounts/{accountName}": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "operationId": "DeletedAccounts_Get", + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetDeletedAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group. ", + "operationId": "DeletedAccounts_Purge", + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/PurgeDeletedAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "Accounts_ListByResourceGroup", + "x-ms-examples": { + "List Accounts by Resource Group": { + "$ref": "./examples/ListAccountsByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "Accounts_List", + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListAccountsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/deletedAccounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "DeletedAccounts_List", + "x-ms-examples": { + "List Deleted Accounts by Subscription": { + "$ref": "./examples/ListDeletedAccountsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "Accounts_ListKeys", + "description": "Lists the account keys for the specified Cognitive Services account.", + "x-ms-examples": { + "List Keys": { + "$ref": "./examples/ListKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns with a response body containing the subscription keys for the resource: key1\nThe first API key for authentication when client calls the API endpoint.\n\nkey2\nThe second API key for authentication when client calls the API endpoint.", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "Accounts_RegenerateKey", + "description": "Regenerates the specified account key for the specified Cognitive Services account.", + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/RegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + }, + "description": "regenerate key parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/skus": { + "get": { + "tags": [ + "Skus", + "CognitiveServicesAccounts" + ], + "operationId": "ResourceSkus_List", + "description": "Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.", + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/GetSkus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/skus": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available SKUs for the requested Cognitive Services account", + "x-ms-examples": { + "List SKUs": { + "$ref": "./examples/ListSkus.json" + } + }, + "operationId": "Accounts_ListSkus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "schema": { + "$ref": "#/definitions/AccountSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "description": "Get usages for the requested subscription", + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/ListUsages.json" + } + }, + "operationId": "Usages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Get usages for the requested Cognitive Services account", + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/GetUsages.json" + } + }, + "operationId": "Accounts_ListUsages", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for Cognitive Services account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/models": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available Models for the requested Cognitive Services account", + "x-ms-examples": { + "List AccountModels": { + "$ref": "./examples/ListAccountModels.json" + } + }, + "operationId": "Accounts_ListModels", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "schema": { + "$ref": "#/definitions/AccountModelListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CognitiveServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available Cognitive Services account operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CheckSkuAvailability", + "description": "Check available SKUs.", + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckSkuAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CheckSkuAvailabilityParameter" + }, + "description": "Check SKU Availability POST body." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SkuAvailabilityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/commitmentTiers": { + "get": { + "tags": [ + "CommitmentTiers" + ], + "operationId": "CommitmentTiers_List", + "description": "List Commitment Tiers.", + "x-ms-examples": { + "ListCommitmentTiers": { + "$ref": "./examples/ListCommitmentTiers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CommitmentTierListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/models": { + "get": { + "tags": [ + "Models" + ], + "operationId": "Models_List", + "description": "List Models.", + "x-ms-examples": { + "ListLocationModels": { + "$ref": "./examples/ListLocationModels.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ModelListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/modelCapacities": { + "get": { + "tags": [ + "ModelCapacities" + ], + "operationId": "LocationBasedModelCapacities_List", + "description": "List Location Based ModelCapacities.", + "x-ms-examples": { + "ListLocationBasedModelCapacities": { + "$ref": "./examples/ListLocationBasedModelCapacities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/modelFormatFilterParameter" + }, + { + "$ref": "#/parameters/modelNameFilterParameter" + }, + { + "$ref": "#/parameters/modelVersionFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved modelCapacities by location.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/modelCapacities": { + "get": { + "tags": [ + "ModelCapacities" + ], + "operationId": "ModelCapacities_List", + "description": "List ModelCapacities.", + "x-ms-examples": { + "ListModelCapacities": { + "$ref": "./examples/ListModelCapacities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/modelFormatFilterParameter" + }, + { + "$ref": "#/parameters/modelNameFilterParameter" + }, + { + "$ref": "#/parameters/modelVersionFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved modelCapacities.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CheckDomainAvailability", + "description": "Check whether a domain is available.", + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckDomainAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CheckDomainAvailabilityParameter" + }, + "description": "Check Domain Availability parameter." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DomainAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/calculateModelCapacity": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "calculateModelCapacity", + "description": "Model capacity calculator.", + "x-ms-examples": { + "Calculate Model Capacity": { + "$ref": "./examples/CalculateModelCapacity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CalculateModelCapacityParameter" + }, + "description": "Check Domain Availability parameter." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CalculateModelCapacityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "Gets the private endpoint connections associated with the Cognitive Services account.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/GetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "PutPrivateEndpointConnection": { + "$ref": "./examples/PutPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "DeletePrivateEndpointConnection": { + "$ref": "./examples/DeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "description": "Gets the private link resources that need to be created for a Cognitive Services account.", + "x-ms-examples": { + "ListPrivateLinkResources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_List", + "description": "Gets the deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "ListDeployments": { + "$ref": "./examples/ListDeployments.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Gets the specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "GetDeployment": { + "$ref": "./examples/GetDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the deployments properties successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "description": "Update the state of specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "PutDeployment": { + "$ref": "./examples/PutDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + }, + { + "name": "deployment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "The deployment properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "201": { + "description": "Create the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Update", + "description": "Update specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "UpdateDeployment": { + "$ref": "./examples/UpdateDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + }, + { + "name": "deployment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + }, + "description": "The deployment properties." + } + ], + "responses": { + "200": { + "description": "Updated the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "If resource is updated successfully, the service should return 201 (OK)." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "description": "Deletes the specified deployment associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteDeployment": { + "$ref": "./examples/DeleteDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the deployment successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The deployment does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListSkus", + "description": "Lists the specified deployments skus associated with the Cognitive Services account.", + "x-ms-examples": { + "ListDeploymentSkus": { + "$ref": "./examples/ListDeploymentSkus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List the deployments skus successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_List", + "description": "Gets the commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListCommitmentPlans.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitmentPlans.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_Get", + "description": "Gets the specified commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the commitmentPlans properties successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_CreateOrUpdate", + "description": "Update the state of specified commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/PutCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "The commitmentPlan properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the CommitmentPlan successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "Create the CommitmentPlan successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_Delete", + "description": "Deletes the specified commitmentPlan associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the commitmentPlan successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The commitmentPlan does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes": { + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_List", + "description": "Gets the content filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListEncryptionScopes": { + "$ref": "./examples/ListEncryptionScopes.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Content Filters.", + "schema": { + "$ref": "#/definitions/EncryptionScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}": { + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Get", + "description": "Gets the specified EncryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "GetEncryptionScope": { + "$ref": "./examples/GetEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the EncryptionScopes properties successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_CreateOrUpdate", + "description": "Update the state of specified encryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "PutEncryptionScope": { + "$ref": "./examples/PutEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + }, + { + "name": "encryptionScope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionScope" + }, + "description": "The encryptionScope properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the EncryptionScope successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "201": { + "description": "Create the EncryptionScope successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Delete", + "description": "Deletes the specified encryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteEncryptionScope": { + "$ref": "./examples/DeleteEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies": { + "get": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_List", + "description": "Gets the content filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListRaiPolicies": { + "$ref": "./examples/ListRaiPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Content Filters.", + "schema": { + "$ref": "#/definitions/RaiPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_List", + "description": "Gets the custom blocklists associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListBlocklists": { + "$ref": "./examples/ListBlocklists.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved blocklists.", + "schema": { + "$ref": "#/definitions/RaiBlockListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_List", + "description": "Gets the blocklist items associated with the custom blocklist.", + "x-ms-examples": { + "ListBlocklistItems": { + "$ref": "./examples/ListBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved blocklist items.", + "schema": { + "$ref": "#/definitions/RaiBlockListItemsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}": { + "get": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_Get", + "description": "Gets the specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "GetRaiPolicy": { + "$ref": "./examples/GetRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_CreateOrUpdate", + "description": "Update the state of specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiPolicy": { + "$ref": "./examples/PutRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + }, + { + "name": "raiPolicy", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiPolicy" + }, + "description": "Properties describing the Content Filters." + } + ], + "responses": { + "200": { + "description": "Create/Update the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "201": { + "description": "Create the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_Delete", + "description": "Deletes the specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "DeleteRaiPolicy": { + "$ref": "./examples/DeleteRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_Get", + "description": "Gets the specified custom blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "GetRaiBlocklist": { + "$ref": "./examples/GetRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_CreateOrUpdate", + "description": "Update the state of specified blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiBlocklist": { + "$ref": "./examples/PutRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklist", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklist" + }, + "description": "Properties describing the custom blocklist." + } + ], + "responses": { + "200": { + "description": "Created/updated the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "201": { + "description": "Created/updated the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_Delete", + "description": "Deletes the specified custom blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "DeleteRaiBlocklist": { + "$ref": "./examples/DeleteRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_Get", + "description": "Gets the specified custom blocklist Item associated with the custom blocklist.", + "x-ms-examples": { + "GetRaiBlocklistItem": { + "$ref": "./examples/GetRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the custom blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_CreateOrUpdate", + "description": "Update the state of specified blocklist item associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiBlocklistItem": { + "$ref": "./examples/PutRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + }, + { + "name": "raiBlocklistItem", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + }, + "description": "Properties describing the custom blocklist." + } + ], + "responses": { + "200": { + "description": "Created/updated the blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "201": { + "description": "Created/updated the blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_Delete", + "description": "Deletes the specified blocklist Item associated with the custom blocklist.", + "x-ms-examples": { + "DeleteRaiBlocklistItem": { + "$ref": "./examples/DeleteRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The blocklist item does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/addRaiBlocklistItems": { + "post": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_BatchAdd", + "description": "Batch operation to add blocklist items.", + "x-ms-examples": { + "AddRaiBlocklistItems": { + "$ref": "./examples/AddRaiBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklistItems", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkAddRequest" + }, + "description": "Properties describing the custom blocklist items." + } + ], + "responses": { + "200": { + "description": "Added the blocklist Items successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/deleteRaiBlocklistItems": { + "post": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_BatchDelete", + "description": "Batch operation to delete blocklist items.", + "x-ms-examples": { + "DeleteRaiBlocklistItems": { + "$ref": "./examples/DeleteRaiBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklistItemsNames", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkDeleteRequest" + }, + "description": "List of RAI Blocklist Items Names." + } + ], + "responses": { + "204": { + "description": "Added the blocklist Items successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raitopics/{raiTopicName}": { + "get": { + "tags": [ + "RaiTopics" + ], + "operationId": "RaiTopics_Get", + "description": "Gets the specified custom topic associated with the Azure OpenAI account.", + "x-ms-examples": { + "GetRaiTopic": { + "$ref": "./examples/GetRaiTopic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiTopicNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the custom topic successfully.", + "schema": { + "$ref": "#/definitions/RaiTopic" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiTopics" + ], + "operationId": "RaiTopics_CreateOrUpdate", + "description": "Create the rai topic associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiTopic": { + "$ref": "./examples/PutRaiTopic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiTopicNameParameter" + }, + { + "name": "raiTopic", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiTopic" + }, + "description": "Properties describing the rai topic." + } + ], + "responses": { + "200": { + "description": "Created/updated the custom topic successfully.", + "schema": { + "$ref": "#/definitions/RaiTopic" + } + }, + "201": { + "description": "Created/updated the custom topic successfully.", + "schema": { + "$ref": "#/definitions/RaiTopic" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiTopics" + ], + "operationId": "RaiTopics_Delete", + "description": "Deletes the specified custom topic associated with the Azure OpenAI account.", + "x-ms-examples": { + "DeleteRaiTopic": { + "$ref": "./examples/DeleteRaiTopic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiTopicNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raitopics": { + "get": { + "tags": [ + "RaiTopics" + ], + "operationId": "RaiTopics_List", + "description": "Gets the custom topics associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListRaiTopics": { + "$ref": "./examples/ListRaiTopics.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved topics.", + "schema": { + "$ref": "#/definitions/RaiTopicResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters": { + "get": { + "tags": [ + "RaiContentFilters" + ], + "operationId": "RaiContentFilters_List", + "description": "List Content Filters types.", + "x-ms-examples": { + "ListRaiContentFilters": { + "$ref": "./examples/ListRaiContentFilters.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/RaiContentFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters/{filterName}": { + "get": { + "tags": [ + "RaiContentFilters" + ], + "operationId": "RaiContentFilters_Get", + "description": "Get Content Filters by Name.", + "x-ms-examples": { + "GetRaiContentFilters": { + "$ref": "./examples/GetRaiContentFilter.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/raiContentFilterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. Get the RAI content filter successfully.", + "schema": { + "$ref": "#/definitions/RaiContentFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}": { + "put": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "operationId": "CommitmentPlans_CreateOrUpdatePlan", + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/CreateSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "The parameters to provide for the created commitment plan." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "operationId": "CommitmentPlans_UpdatePlan", + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/UpdateSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + }, + "description": "The parameters to provide for the created commitment plan." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is updated successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "If resource is updated successfully, the service should return 201 (OK)." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Deletes a Cognitive Services commitment plan from the resource group. ", + "operationId": "CommitmentPlans_DeletePlan", + "x-ms-examples": { + "Delete Commitment Plan": { + "$ref": "./examples/DeleteSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns a Cognitive Services commitment plan specified by the parameters.", + "operationId": "CommitmentPlans_GetPlan", + "x-ms-examples": { + "Get Commitment Plan": { + "$ref": "./examples/GetSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "CommitmentPlans_ListPlansByResourceGroup", + "x-ms-examples": { + "List Commitment Plans by Resource Group": { + "$ref": "./examples/ListSharedCommitmentPlansByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "CommitmentPlans_ListPlansBySubscription", + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListSharedCommitmentPlansBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_ListAssociations", + "description": "Gets the associations of the Cognitive Services commitment plan.", + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListSharedCommitmentPlanAssociations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Commitment Plan Associations.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations/{commitmentPlanAssociationName}": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_GetAssociation", + "description": "Gets the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetSharedCommitmentPlanAssociation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_CreateOrUpdateAssociation", + "description": "Create or update the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/CreateSharedCommitmentPlanAssociation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + }, + { + "name": "association", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "description": "The commitmentPlan properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "201": { + "description": "Create the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_DeleteAssociation", + "description": "Deletes the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteSharedCommitmentPlanAssociation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the CommitmentPlanAssociation successfully." + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The Commitment Plan Association does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_List", + "description": "Gets a list of NSP configurations for an account.", + "x-ms-examples": { + "ListNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ListNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of configs.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_Get", + "description": "Gets the specified NSP configurations for an account.", + "x-ms-examples": { + "GetNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/GetNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/nspConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the config.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}/reconcile": { + "post": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_Reconcile", + "description": "Reconcile the NSP configuration for an account.", + "x-ms-examples": { + "ReconcileNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ReconcileNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/nspConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully Reconciled the NSP configuration.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "Request to reconcile the NSP configuration accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings": { + "get": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_List", + "description": "Lists the Defender for AI settings.", + "x-ms-examples": { + "ListDefenderForAISetting": { + "$ref": "./examples/ListDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List the defender setting name successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISettingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings/{defenderForAISettingName}": { + "get": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_Get", + "description": "Gets the specified Defender for AI setting by name.", + "x-ms-examples": { + "GetDefenderForAISetting": { + "$ref": "./examples/GetDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the defender setting name successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_CreateOrUpdate", + "description": "Creates or Updates the specified Defender for AI setting.", + "x-ms-examples": { + "PutDefenderForAISetting": { + "$ref": "./examples/PutDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + }, + { + "name": "defenderForAISettings", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "description": "Properties describing the Defender for AI setting." + } + ], + "responses": { + "200": { + "description": "Created/updated the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "201": { + "description": "Created the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_Update", + "description": "Updates the specified Defender for AI setting.", + "x-ms-examples": { + "UpdateDefenderForAISetting": { + "$ref": "./examples/UpdateDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + }, + { + "name": "defenderForAISettings", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "description": "Properties describing the Defender for AI setting." + } + ], + "responses": { + "200": { + "description": "Updated the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}": { + "put": { + "tags": [ + "CognitiveServicesProjects" + ], + "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.", + "operationId": "Projects_Create", + "x-ms-examples": { + "Create Project": { + "$ref": "./examples/CreateProject.json" + }, + "Create Project Min": { + "$ref": "./examples/CreateProjectMin.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "name": "project", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + }, + "description": "The parameters to provide for the created project." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Updates a Cognitive Services Project", + "operationId": "Projects_Update", + "x-ms-examples": { + "Update Project": { + "$ref": "./examples/UpdateProjects.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "name": "project", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + }, + "description": "The parameters to provide for the created project." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Deletes a Cognitive Services project from the resource group. ", + "operationId": "Projects_Delete", + "x-ms-examples": { + "Delete Project": { + "$ref": "./examples/DeleteProject.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Returns a Cognitive Services project specified by the parameters.", + "operationId": "Projects_Get", + "x-ms-examples": { + "Get Project": { + "$ref": "./examples/GetProject.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects": { + "get": { + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Returns all the projects in a Cognitive Services account.", + "operationId": "Projects_List", + "x-ms-examples": { + "List Project": { + "$ref": "./examples/ListProjects.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}": { + "delete": { + "tags": [ + "AccountConnectionResource" + ], + "summary": "Delete Cognitive Services account connection by name.", + "operationId": "AccountConnections_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteAccountConnection": { + "$ref": "./examples/AccountConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "AccountConnectionResource" + ], + "summary": "Lists Cognitive Services account connection by name.", + "operationId": "AccountConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAccountConnection": { + "$ref": "./examples/AccountConnection/get.json" + } + } + }, + "patch": { + "tags": [ + "AccountConnectionResource" + ], + "summary": "Update Cognitive Services account connection under the specified account.", + "operationId": "AccountConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "connection", + "description": "Parameters for account connection update.", + "schema": { + "$ref": "#/definitions/ConnectionUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateAccountConnection": { + "$ref": "./examples/AccountConnection/update.json" + } + } + }, + "put": { + "tags": [ + "AccountConnectionResource" + ], + "summary": "Create or update Cognitive Services account connection under the specified account.", + "operationId": "AccountConnections_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "connection", + "description": "The object for creating or updating a new account connection", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateAccountConnection": { + "$ref": "./examples/AccountConnection/create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections": { + "get": { + "tags": [ + "AccountConnectionResource" + ], + "summary": "Lists all the available Cognitive Services account connections under the specified account.", + "operationId": "AccountConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "includeAll", + "description": "query parameter that indicates if get connection call should return both connections and datastores", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListAccountConnections": { + "$ref": "./examples/AccountConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}": { + "delete": { + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Delete Cognitive Services project connection by name.", + "operationId": "ProjectConnections_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteProjectConnection": { + "$ref": "./examples/ProjectConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Lists Cognitive Services project connection by name.", + "operationId": "ProjectConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetProjectConnection": { + "$ref": "./examples/ProjectConnection/get.json" + } + } + }, + "patch": { + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Update Cognitive Services project connection under the specified project.", + "operationId": "ProjectConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "connection", + "description": "Parameters for account connection update.", + "schema": { + "$ref": "#/definitions/ConnectionUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateProjectConnection": { + "$ref": "./examples/ProjectConnection/update.json" + } + } + }, + "put": { + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Create or update Cognitive Services project connection under the specified project.", + "operationId": "ProjectConnections_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "connection", + "description": "The object for creating or updating a new account connection", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateProjectConnection": { + "$ref": "./examples/ProjectConnection/create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections": { + "get": { + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Lists all the available Cognitive Services project connections under the specified project.", + "operationId": "ProjectConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "includeAll", + "description": "query parameter that indicates if get connection call should return both connections and datastores", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListProjectConnection": { + "$ref": "./examples/ProjectConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts/{capabilityHostName}": { + "delete": { + "tags": [ + "AccountCapabilityHost" + ], + "summary": "Delete account capabilityHost.", + "operationId": "AccountCapabilityHosts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/capabilityHostNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Account CapabilityHost.": { + "$ref": "./examples/AccountCapabilityHost/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "AccountCapabilityHost" + ], + "summary": "Get account capabilityHost.", + "operationId": "AccountCapabilityHosts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/capabilityHostNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Account CapabilityHost.": { + "$ref": "./examples/AccountCapabilityHost/get.json" + } + } + }, + "put": { + "tags": [ + "AccountCapabilityHost" + ], + "summary": "Create or update account capabilityHost.", + "operationId": "AccountCapabilityHosts_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/capabilityHostNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "capabilityHost", + "description": "CapabilityHost definition.", + "required": true, + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Account CapabilityHost.": { + "$ref": "./examples/AccountCapabilityHost/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts/{capabilityHostName}": { + "delete": { + "tags": [ + "ProjectCapabilityHost" + ], + "summary": "Delete project capabilityHost.", + "operationId": "ProjectCapabilityHosts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/capabilityHostNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Project CapabilityHost.": { + "$ref": "./examples/ProjectCapabilityHost/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ProjectCapabilityHost" + ], + "summary": "Get project capabilityHost.", + "operationId": "ProjectCapabilityHosts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/capabilityHostNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Project CapabilityHost.": { + "$ref": "./examples/ProjectCapabilityHost/get.json" + } + } + }, + "put": { + "tags": [ + "ProjectCapabilityHost" + ], + "summary": "Create or update project capabilityHost.", + "operationId": "ProjectCapabilityHosts_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "#/parameters/capabilityHostNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "capabilityHost", + "description": "CapabilityHost definition.", + "required": true, + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CapabilityHostResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Project CapabilityHost.": { + "$ref": "./examples/ProjectCapabilityHost/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/quotaTiers": { + "get": { + "tags": [ + "QuotaTier" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "QuotaTiers_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaTierListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the Quota Tier for a subscription": { + "$ref": "./examples/ListQuotaTiers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/quotaTiers/{default}": { + "get": { + "tags": [ + "QuotaTier" + ], + "operationId": "QuotaTiers_Get", + "summary": "Gets the Quota Tier for a subscription", + "description": "Gets the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/defaultParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the Quota Tier information for a subscription": { + "$ref": "./examples/GetQuotaTier.json" + } + } + }, + "patch": { + "tags": [ + "QuotaTier" + ], + "operationId": "QuotaTiers_Update", + "summary": "Updates the Quota Tier resource for a subscription. The only properties that can be updated are \"tierUpgradePolicy\"", + "description": "Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/defaultParameter" + }, + { + "name": "tier", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaTier" + }, + "description": "The parameters to provide for the quota tier resource." + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update the quota tier resource for a subscription": { + "$ref": "./examples/UpdateQuotaTier.json" + } + } + }, + "put": { + "tags": [ + "QuotaTier" + ], + "operationId": "QuotaTiers_CreateOrUpdate", + "summary": "Updates the Quota Tier resource for a subscription.", + "description": "Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/defaultParameter" + }, + { + "name": "tier", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaTier" + }, + "description": "The parameters to provide for the quota tier resource." + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "201": { + "description": "Create the QuotaTier successfully.", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update the quota tier resource for a subscription": { + "$ref": "./examples/CreateOrUpdateQuotaTier.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules/{ruleName}": { + "delete": { + "tags": [ + "ManagedNetwork" + ], + "summary": "The DELETE API for deleting a single outbound rule of the managed network associated with the cognitive services account.", + "operationId": "OutboundRule_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete OutboundRule": { + "$ref": "./examples/ManagedNetwork/deleteRuleV2.json" + } + } + }, + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "The GET API for retrieving a single outbound rule of the managed network associated with the cognitive services account.", + "operationId": "OutboundRule_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OutboundRule": { + "$ref": "./examples/ManagedNetwork/getRuleV2.json" + } + } + }, + "put": { + "tags": [ + "ManagedNetwork" + ], + "summary": "The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account.", + "operationId": "OutboundRule_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + }, + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "CreateOrUpdate OutboundRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRuleV2.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules": { + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "The GET API for retrieving the list of outbound rules of the managed network associated with the cognitive services account.", + "operationId": "OutboundRule_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List OutboundRules": { + "$ref": "./examples/ManagedNetwork/listRuleV2.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/batchOutboundRules": { + "post": { + "tags": [ + "ManagedNetwork" + ], + "summary": "The POST API for updating the outbound rules of the managed network associated with the cognitive services account.", + "operationId": "OutboundRules_Post", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The Managed Network Settings object of the account.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsBasicResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Post OutboundRules": { + "$ref": "./examples/ManagedNetwork/postOutboundRulesV2.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}": { + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Get API for managed network settings of a cognitive services account.", + "operationId": "ManagedNetworkSettings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/getManagedNetworkV2.json" + } + } + }, + "patch": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Patch API for managed network settings of a cognitive services account.", + "operationId": "ManagedNetworkSettings_Patch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The Managed Network Settings object of the account.", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/patchManagedNetworkV2.json" + } + } + }, + "put": { + "tags": [ + "ManagedNetwork" + ], + "summary": "PUT API for managed network settings of a cognitive services account.", + "operationId": "ManagedNetworkSettings_Put", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/ManagedNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The Managed Network Settings object of the account.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + }, + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Put ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks": { + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "List API for managed network settings of a cognitive services account.", + "operationId": "ManagedNetworkSettings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/listManagedNetworkV2.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/provisionManagedNetwork": { + "post": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Provisions the managed network of a cognitive services account.", + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Managed Network Provisioning Options for a cognitive services account.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionOptions" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provisionManagedNetwork.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications": { + "get": { + "tags": [ + "AgentApplication" + ], + "summary": "Lists Agent Applications in the project.", + "operationId": "AgentApplications_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of agent applications to be retrieved in a page of results.", + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "in": "query", + "name": "$skip", + "description": "Number of agent applications to skip.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "$skipToken", + "description": "Continuation token for pagination.", + "type": "string" + }, + { + "in": "query", + "name": "names", + "description": "Names of agent applications to retrieve.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "searchText", + "description": "Search text for filtering agent applications.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Field to order by.", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Whether to order in ascending order.", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AgentApplicationResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Account Agent Applications.": { + "$ref": "./examples/AgentApplication/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}": { + "delete": { + "tags": [ + "AgentApplication" + ], + "summary": "Delete Agent Application.", + "operationId": "AgentApplications_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Agent Application name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Account Agent Application.": { + "$ref": "./examples/AgentApplication/delete.json" + } + } + }, + "get": { + "tags": [ + "AgentApplication" + ], + "summary": "Gets an Agent Application by name.", + "operationId": "AgentApplications_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Name for the Agent Application.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AgentApplicationResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Account Agent Application.": { + "$ref": "./examples/AgentApplication/get.json" + } + } + }, + "put": { + "tags": [ + "AgentApplication" + ], + "summary": "Creates or updates an Agent Application (asynchronous).", + "operationId": "AgentApplications_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Name for the Agent Application.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Agent Application definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/AgentApplicationResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/AgentApplicationResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AgentApplicationResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Account Agent Application.": { + "$ref": "./examples/AgentApplication/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}/listAgents": { + "post": { + "tags": [ + "AgentApplication" + ], + "summary": "Lists agents for an Agent Application.", + "operationId": "AgentApplications_ListAgents", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Agent Application name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AgentDefinitionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Agents for Agent Application.": { + "$ref": "./examples/AgentApplication/listAgents.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}/listDeployments": { + "post": { + "tags": [ + "AgentApplication" + ], + "summary": "Lists deployments for an Agent Application.", + "operationId": "AgentApplications_ListDeployments", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/projectNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Agent Application name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AgentDeploymentResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deployments for Agent Application.": { + "$ref": "./examples/AgentApplication/listDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "Sku": { + "description": "The resource model definition representing SKU", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "tier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium", + "Enterprise" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "SkuName": { + "type": "string", + "description": "The name of SKU." + }, + "Account": { + "description": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "identity": { + "$ref": "#/definitions/Identity" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "Properties of Cognitive Services account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ] + }, + "AccountListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of accounts.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the cognitive services account at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "ResolvingDNS" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "type": "string", + "description": "Endpoint of the created account.", + "readOnly": true + }, + "internalId": { + "type": "string", + "description": "The internal identifier (deprecated, do not use this property).", + "readOnly": true + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only." + }, + "isMigrated": { + "type": "boolean", + "description": "If the resource is migrated from an existing key.", + "readOnly": true + }, + "migrationToken": { + "type": "string", + "description": "Resource migration token." + }, + "skuChangeInfo": { + "$ref": "#/definitions/SkuChangeInfo", + "description": "Sku change info of account.", + "readOnly": true + }, + "customSubDomainName": { + "type": "string", + "description": "Optional subdomain name used for token-based authentication." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "The encryption properties for this resource." + }, + "userOwnedStorage": { + "type": "array", + "items": { + "$ref": "#/definitions/UserOwnedStorage" + }, + "x-ms-identifiers": [ + "resourceId" + ], + "description": "The storage accounts for this resource." + }, + "amlWorkspace": { + "$ref": "#/definitions/UserOwnedAmlWorkspace", + "description": "The user owned AML account properties." + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection associated with the Cognitive Services account." + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether or not public endpoint access is allowed for this account.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "apiProperties": { + "$ref": "#/definitions/ApiProperties", + "description": "The api properties for special APIs." + }, + "dateCreated": { + "readOnly": true, + "type": "string", + "description": "Gets the date of cognitive services account creation." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "The flag to enable dynamic throttling." + }, + "storedCompletionsDisabled": { + "type": "boolean", + "description": "The flag to disable stored completions." + }, + "quotaLimit": { + "readOnly": true, + "$ref": "#/definitions/QuotaLimit" + }, + "restrictOutboundNetworkAccess": { + "type": "boolean" + }, + "allowedFqdnList": { + "type": "array", + "items": { + "type": "string" + } + }, + "disableLocalAuth": { + "type": "boolean" + }, + "endpoints": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "restore": { + "type": "boolean", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "deletionDate": { + "type": "string", + "description": "The deletion date, only available for deleted account.", + "readOnly": true + }, + "scheduledPurgeDate": { + "type": "string", + "description": "The scheduled purge date, only available for deleted account.", + "readOnly": true + }, + "locations": { + "$ref": "#/definitions/MultiRegionSettings", + "description": "The multiregion settings of Cognitive Services account." + }, + "commitmentPlanAssociations": { + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlanAssociation" + }, + "x-ms-identifiers": [ + "commitmentPlanId" + ], + "description": "The commitment plan associations of Cognitive Services account.", + "readOnly": true + }, + "abusePenalty": { + "readOnly": true, + "$ref": "#/definitions/AbusePenalty" + }, + "raiMonitorConfig": { + "$ref": "#/definitions/RaiMonitorConfig" + }, + "networkInjections": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInjection" + } + }, + "allowProjectManagement": { + "type": "boolean", + "description": "Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry." + }, + "defaultProject": { + "type": "string", + "description": "Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter." + }, + "associatedProjects": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the projects, by project name, that are associated with this resource." + } + }, + "description": "Properties of Cognitive Services account." + }, + "ApiProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "properties": { + "qnaRuntimeEndpoint": { + "type": "string", + "description": "(QnAMaker Only) The runtime endpoint of QnAMaker." + }, + "qnaAzureSearchEndpointKey": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker." + }, + "qnaAzureSearchEndpointId": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker." + }, + "statisticsEnabled": { + "type": "boolean", + "description": "(Bing Search Only) The flag to enable statistics of Bing Search." + }, + "eventHubConnectionString": { + "type": "string", + "description": "(Personalization Only) The flag to enable statistics of Bing Search.", + "pattern": "^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$", + "maxLength": 1000 + }, + "storageAccountConnectionString": { + "type": "string", + "description": "(Personalization Only) The storage account connection string.", + "pattern": "^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$", + "maxLength": 1000 + }, + "aadClientId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).", + "maxLength": 500 + }, + "aadTenantId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Tenant Id.", + "maxLength": 500 + }, + "superUser": { + "type": "string", + "description": "(Metrics Advisor Only) The super user of Metrics Advisor.", + "maxLength": 500 + }, + "websiteName": { + "type": "string", + "description": "(Metrics Advisor Only) The website name of Metrics Advisor.", + "maxLength": 500 + } + }, + "description": "The api properties for special APIs." + }, + "CommitmentPlanAccountAssociationListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Commitment Plan Account Association.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "x-ms-identifiers": [ + "id" + ], + "description": "Gets the list of Cognitive Services Commitment Plan Account Association and their properties." + } + }, + "description": "The list of cognitive services Commitment Plan Account Association operation response." + }, + "CommitmentPlanAccountAssociation": { + "description": "The commitment plan association.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommitmentPlanAccountAssociationProperties", + "description": "Properties of Cognitive Services account commitment plan association." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AbusePenalty": { + "description": "The abuse penalty.", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "Throttle", + "Block" + ], + "x-ms-enum": { + "name": "AbusePenaltyAction", + "modelAsString": true + }, + "description": "The action of AbusePenalty." + }, + "rateLimitPercentage": { + "type": "number", + "description": "The percentage of rate limit." + }, + "expiration": { + "type": "string", + "format": "date-time", + "description": "The datetime of expiration of the AbusePenalty." + } + } + }, + "CommitmentPlanAccountAssociationProperties": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "The Azure resource id of the account." + } + }, + "description": "The commitment plan account association properties." + }, + "CommitmentPlanAssociation": { + "type": "object", + "properties": { + "commitmentPlanId": { + "type": "string", + "description": "The Azure resource id of the commitment plan." + }, + "commitmentPlanLocation": { + "type": "string", + "description": "The location of of the commitment plan." + } + }, + "description": "The commitment plan association." + }, + "MultiRegionSettings": { + "type": "object", + "properties": { + "routingMethod": { + "type": "string", + "enum": [ + "Priority", + "Weighted", + "Performance" + ], + "x-ms-enum": { + "name": "RoutingMethods", + "modelAsString": true + }, + "description": "Multiregion routing methods." + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionSetting" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "description": "The multiregion settings Cognitive Services account." + }, + "RegionSetting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the region." + }, + "value": { + "type": "number", + "description": "A value for priority or weighted routing methods." + }, + "customsubdomain": { + "type": "string", + "description": "Maps the region to the regional custom subdomain." + } + }, + "description": "The call rate limit Cognitive Services account." + }, + "CapacityConfig": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity." + }, + "step": { + "type": "integer", + "format": "int32", + "description": "The minimal incremental between allowed values for capacity." + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity." + }, + "allowedValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The array of allowed values for capacity." + } + }, + "description": "The capacity configuration." + }, + "CallRateLimit": { + "type": "object", + "properties": { + "count": { + "type": "number", + "description": "The count value of Call Rate Limit." + }, + "renewalPeriod": { + "type": "number", + "description": "The renewal period in seconds of Call Rate Limit." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + }, + "description": "The call rate limit Cognitive Services account." + }, + "BillingMeterInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "meterId": { + "type": "string" + }, + "unit": { + "type": "string" + } + } + }, + "DeploymentCapacitySettings": { + "type": "object", + "description": "Internal use only.", + "properties": { + "designatedCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The designated capacity." + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The priority of this capacity setting." + } + } + }, + "QuotaLimit": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "renewalPeriod": { + "type": "number" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "ThrottlingRule": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "renewalPeriod": { + "type": "number" + }, + "count": { + "type": "number" + }, + "minCount": { + "type": "number" + }, + "dynamicThrottlingEnabled": { + "type": "boolean" + }, + "matchPatterns": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestMatchPattern" + }, + "x-ms-identifiers": [ + "path", + "method" + ] + } + } + }, + "RequestMatchPattern": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "method": { + "type": "string" + } + } + }, + "ApiKeys": { + "type": "object", + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + }, + "description": "The access keys for the cognitive services account." + }, + "SkuChangeInfo": { + "type": "object", + "properties": { + "countOfDowngrades": { + "type": "number", + "description": "Gets the count of downgrades." + }, + "countOfUpgradesAfterDowngrades": { + "type": "number", + "description": "Gets the count of upgrades after downgrades." + }, + "lastChangeDate": { + "type": "string", + "description": "Gets the last change date." + } + }, + "description": "Sku change info of account." + }, + "RegenerateKeyParameters": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "key name to generate (Key1|Key2)", + "enum": [ + "Key1", + "Key2" + ], + "x-ms-enum": { + "name": "KeyName", + "modelAsString": false + } + } + }, + "required": [ + "keyName" + ], + "description": "Regenerate key parameters." + }, + "AccountSkuListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountSku" + }, + "x-ms-identifiers": [ + "sku/name", + "resourceType" + ], + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource Namespace and Type" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of Cognitive Services account." + } + }, + "description": "Cognitive Services resource type and SKU." + }, + "UsageListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Usages.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of usages for Cognitive Service account." + } + }, + "description": "The response to a list usage request." + }, + "Usage": { + "type": "object", + "properties": { + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "name": { + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "quotaPeriod": { + "type": "string", + "description": "The quota period used to summarize the usage values." + }, + "limit": { + "type": "number", + "format": "double", + "description": "Maximum value for this metric." + }, + "currentValue": { + "type": "number", + "format": "double", + "description": "Current value for this metric." + }, + "nextResetTime": { + "type": "string", + "description": "Next reset time for current quota." + }, + "status": { + "type": "string", + "description": "Cognitive Services account quota usage status.", + "enum": [ + "Included", + "Blocked", + "InOverage", + "Unknown" + ], + "x-ms-enum": { + "name": "QuotaUsageStatus", + "modelAsString": true + } + } + }, + "description": "The usage data for a usage request." + }, + "MetricName": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of the metric." + }, + "localizedValue": { + "type": "string", + "description": "The friendly name of the metric." + } + }, + "description": "A metric name." + }, + "UnitType": { + "type": "string", + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond", + "Milliseconds" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "UnitType" + } + }, + "CheckSkuAvailabilityParameter": { + "type": "object", + "description": "Check SKU availability parameter.", + "properties": { + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuName" + }, + "description": "The SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind" + }, + "type": { + "type": "string", + "description": "The Type of the resource." + } + }, + "required": [ + "skus", + "kind", + "type" + ] + }, + "CalculateModelCapacityParameter": { + "type": "object", + "description": "Calculate Model Capacity parameter.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "$ref": "#/definitions/SkuName" + }, + "workloads": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkload" + }, + "x-ms-identifiers": [], + "description": "List of Model Capacity Calculator Workload." + } + } + }, + "ModelCapacityCalculatorWorkload": { + "type": "object", + "description": "Model Capacity Calculator Workload.", + "properties": { + "requestPerMinute": { + "type": "integer", + "format": "int64", + "description": "Request per minute." + }, + "requestParameters": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkloadRequestParam" + } + } + }, + "ModelCapacityCalculatorWorkloadRequestParam": { + "type": "object", + "description": "Dictionary, Model Capacity Calculator Workload Parameters.", + "properties": { + "avgPromptTokens": { + "type": "integer", + "format": "int64", + "description": "Average prompt tokens." + }, + "avgGeneratedTokens": { + "type": "integer", + "format": "int64", + "description": "Average generated tokens." + } + } + }, + "CalculateModelCapacityResult": { + "type": "object", + "description": "Calculate Model Capacity result.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "type": "string" + }, + "estimatedCapacity": { + "type": "object", + "description": "Model Estimated Capacity.", + "properties": { + "value": { + "type": "integer", + "format": "int32" + }, + "deployableValue": { + "type": "integer", + "format": "int32" + } + } + } + } + }, + "SkuAvailabilityListResult": { + "type": "object", + "description": "Check SKU availability result list.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuAvailability" + }, + "x-ms-identifiers": [ + "skuName", + "type", + "kind" + ], + "description": "Check SKU availability result list." + } + } + }, + "SkuAvailability": { + "type": "object", + "description": "SKU availability.", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "skuName": { + "$ref": "#/definitions/SkuName", + "description": "The SKU of Cognitive Services account." + }, + "skuAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "message": { + "type": "string", + "description": "Additional error message." + } + } + }, + "SkuCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SkuCapability." + }, + "value": { + "type": "string", + "description": "The value of the SkuCapability." + } + }, + "description": "SkuCapability indicates the capability of a certain feature." + }, + "CheckDomainAvailabilityParameter": { + "type": "object", + "description": "Check Domain availability parameter.", + "properties": { + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + } + }, + "required": [ + "subdomainName", + "type" + ] + }, + "DomainAvailability": { + "type": "object", + "description": "Domain availability.", + "properties": { + "isSubdomainAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + } + } + }, + "ResourceSkuRestrictions": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": false + } + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "type": "string", + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true + } + } + }, + "description": "Describes restrictions of a SKU." + }, + "ResourceSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of Cognitive Services account." + }, + "kind": { + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "x-ms-identifiers": [], + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available Cognitive Services SKU." + }, + "ResourceSkuRestrictionInfo": { + "type": "object", + "properties": { + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Locations where the SKU is restricted" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is restricted." + } + } + }, + "ResourceSkuListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "x-ms-identifiers": [ + "resourceType", + "name", + "kind" + ], + "description": "The list of skus available for the subscription." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Skus." + } + }, + "required": [ + "value" + ], + "description": "The Get Skus operation response." + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "defaultAction": { + "type": "string", + "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkRuleAction", + "modelAsString": true + } + }, + "bypass": { + "type": "string", + "description": "Setting for trusted services.", + "enum": [ + "None", + "AzureServices" + ], + "x-ms-enum": { + "name": "ByPassSelection", + "modelAsString": true + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/IpRule" + }, + "x-ms-identifiers": [], + "description": "The list of IP address rules." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility." + }, + "IpRule": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78)." + } + }, + "required": [ + "value" + ], + "description": "A rule governing the accessibility from a specific ip address or ip range." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'." + }, + "state": { + "type": "string", + "description": "Gets the state of virtual network rule." + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Ignore missing vnet service endpoint or not." + } + }, + "required": [ + "id" + ], + "description": "A rule governing the accessibility from a specific virtual network." + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "userAssignedIdentities": { + "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}", + "type": "object", + "additionalProperties": { + "description": "User-assigned managed identity.", + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User-assigned managed identity.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "Azure Active Directory principal ID associated with this Identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "Client App Id associated with this identity." + } + } + }, + "Encryption": { + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.CognitiveServices", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": true + } + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVersion": { + "type": "string", + "description": "Version of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + }, + "identityClientId": { + "type": "string" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "EncryptionScopeListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of EncryptionScope.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionScope" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of EncryptionScope." + } + }, + "description": "The list of cognitive services EncryptionScopes." + }, + "EncryptionScope": { + "type": "object", + "description": "Cognitive Services EncryptionScope", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/EncryptionScopeProperties", + "description": "Properties of Cognitive Services EncryptionScope." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "EncryptionScopeProperties": { + "type": "object", + "description": "Properties to EncryptionScope", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "EncryptionScopeProvisioningState", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The encryptionScope state.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "EncryptionScopeState", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Encryption" + } + ] + }, + "UserOwnedStorage": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a Microsoft.Storage resource." + }, + "identityClientId": { + "type": "string" + } + }, + "description": "The user owned storage for Cognitive Services account." + }, + "UserOwnedAmlWorkspace": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a AML account resource." + }, + "identityClientId": { + "type": "string", + "description": "Identity Client id of a AML account resource." + } + }, + "description": "The user owned AML account for Cognitive Services account." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "A list of private endpoint connections" + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "location": { + "type": "string", + "description": "The location of the private endpoint connection" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource group ids." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + }, + "displayName": { + "description": "The private link resource display name.", + "type": "string", + "readOnly": true + } + }, + "description": "Properties of a private link resource." + }, + "DeploymentListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Deployment.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + }, + "description": "Gets the list of Cognitive Services accounts Deployment and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "Deployment": { + "description": "Cognitive Services account deployment.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "Properties of Cognitive Services account deployment." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Disabled", + "Canceled" + ], + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true + } + }, + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "scaleSettings": { + "$ref": "#/definitions/DeploymentScaleSettings" + }, + "capabilities": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities." + }, + "raiPolicyName": { + "type": "string", + "description": "The name of RAI policy." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + }, + "rateLimits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "versionUpgradeOption": { + "type": "string", + "description": "Deployment model version upgrade option.", + "enum": [ + "OnceNewDefaultVersionAvailable", + "OnceCurrentVersionExpired", + "NoAutoUpgrade" + ], + "x-ms-enum": { + "name": "DeploymentModelVersionUpgradeOption", + "modelAsString": true + } + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "If the dynamic throttling is enabled.", + "readOnly": true + }, + "currentCapacity": { + "type": "integer", + "format": "int32", + "description": "The current capacity." + }, + "capacitySettings": { + "$ref": "#/definitions/DeploymentCapacitySettings" + }, + "parentDeploymentName": { + "type": "string", + "description": "The name of parent deployment." + }, + "spilloverDeploymentName": { + "type": "string", + "description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit." + } + }, + "description": "Properties of Cognitive Services account deployment." + }, + "DeploymentModel": { + "type": "object", + "properties": { + "publisher": { + "type": "string", + "description": "Deployment model publisher." + }, + "format": { + "type": "string", + "description": "Deployment model format." + }, + "name": { + "type": "string", + "description": "Deployment model name." + }, + "version": { + "type": "string", + "description": "Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API." + }, + "source": { + "type": "string", + "description": "Optional. Deployment model source ARM resource ID." + }, + "sourceAccount": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + } + }, + "description": "Properties of Cognitive Services account deployment model." + }, + "DeploymentScaleSettings": { + "type": "object", + "properties": { + "scaleType": { + "type": "string", + "description": "Deployment scale type.", + "enum": [ + "Standard", + "Manual" + ], + "x-ms-enum": { + "name": "DeploymentScaleType", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Deployment capacity." + }, + "activeCapacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`." + } + }, + "description": "Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)" + }, + "DeploymentSkuListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of deployment skus.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" + }, + "x-ms-identifiers": [ + "resourceType" + ], + "description": "Gets the list of Cognitive Services accounts deployment skus." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "SkuResource": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type name." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig" + } + }, + "description": "Properties of Cognitive Services account resource sku resource properties." + }, + "CommitmentTierListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of CommitmentTier.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentTier" + }, + "x-ms-identifiers": [ + "kind", + "tier", + "skuName", + "hostingModel", + "planType" + ], + "description": "Gets the list of Cognitive Services accounts CommitmentTier and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CommitmentTier": { + "description": "Cognitive Services account commitment tier.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "skuName": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment max count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota" + }, + "cost": { + "$ref": "#/definitions/CommitmentCost" + } + } + }, + "CommitmentQuota": { + "type": "object", + "properties": { + "quantity": { + "type": "integer", + "format": "int64", + "description": "Commitment quota quantity." + }, + "unit": { + "type": "string", + "description": "Commitment quota unit." + } + }, + "description": "Cognitive Services account commitment quota." + }, + "CommitmentCost": { + "type": "object", + "properties": { + "commitmentMeterId": { + "type": "string", + "description": "Commitment meter Id." + }, + "overageMeterId": { + "type": "string", + "description": "Overage meter Id." + } + }, + "description": "Cognitive Services account commitment cost." + }, + "CommitmentPlanListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of CommitmentPlan.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "Gets the list of Cognitive Services accounts CommitmentPlan and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CommitmentPlan": { + "description": "Cognitive Services account commitment plan.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/CommitmentPlanProperties", + "description": "Properties of Cognitive Services account commitment plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CommitmentPlanProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "CommitmentPlanProvisioningState", + "modelAsString": true + } + }, + "commitmentPlanGuid": { + "type": "string", + "description": "Commitment plan guid." + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "current": { + "$ref": "#/definitions/CommitmentPeriod" + }, + "autoRenew": { + "type": "boolean", + "description": "AutoRenew commitment plan." + }, + "next": { + "$ref": "#/definitions/CommitmentPeriod" + }, + "last": { + "$ref": "#/definitions/CommitmentPeriod", + "readOnly": true + }, + "provisioningIssues": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of ProvisioningIssue." + } + }, + "description": "Properties of Cognitive Services account commitment plan." + }, + "HostingModel": { + "type": "string", + "description": "Account hosting model.", + "enum": [ + "Web", + "ConnectedContainer", + "DisconnectedContainer", + "ProvisionedWeb" + ], + "x-ms-enum": { + "name": "HostingModel", + "modelAsString": true + } + }, + "CommitmentPeriod": { + "type": "object", + "properties": { + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota", + "readOnly": true + }, + "startDate": { + "type": "string", + "description": "Commitment period start date.", + "readOnly": true + }, + "endDate": { + "type": "string", + "description": "Commitment period end date.", + "readOnly": true + } + }, + "description": "Cognitive Services account commitment period." + }, + "ModelListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Model.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Model" + }, + "x-ms-identifiers": [ + "kind", + "skuName", + "/model/name", + "/model/format", + "/model/version" + ], + "description": "Gets the list of Cognitive Services accounts Model and their properties." + } + }, + "description": "The list of cognitive services models." + }, + "Model": { + "description": "Cognitive Services Model.", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/AccountModel" + }, + "kind": { + "$ref": "#/definitions/Kind" + }, + "skuName": { + "$ref": "#/definitions/SkuName" + }, + "description": { + "type": "string", + "description": "The description of the model." + } + } + }, + "ModelSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the model SKU." + }, + "usageName": { + "type": "string", + "description": "The usage name of the model SKU." + }, + "deprecationDate": { + "type": "string", + "format": "date-time", + "description": "The datetime of deprecation of the model SKU." + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig" + }, + "rateLimits": { + "type": "array", + "items": { + "$ref": "#/definitions/CallRateLimit" + }, + "x-ms-identifiers": [], + "description": "The list of rateLimit." + }, + "cost": { + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeterInfo" + }, + "x-ms-identifiers": [], + "description": "The list of billing meter info." + } + }, + "description": "Describes an available Cognitive Services Model SKU." + }, + "AccountModelListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Model.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountModel" + }, + "x-ms-identifiers": [ + "name", + "format", + "version" + ], + "description": "Gets the list of Cognitive Services accounts Model and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountModel": { + "description": "Cognitive Services account Model.", + "type": "object", + "properties": { + "baseModel": { + "$ref": "#/definitions/DeploymentModel" + }, + "isDefaultVersion": { + "type": "boolean", + "description": "If the model is default version." + }, + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelSku" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Model Sku." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "description": "The max capacity." + }, + "capabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities." + }, + "finetuneCapabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities for finetune models." + }, + "deprecation": { + "$ref": "#/definitions/ModelDeprecationInfo" + }, + "replacementConfig": { + "$ref": "#/definitions/ReplacementConfig" + }, + "modelCatalogAssetId": { + "type": "string", + "description": "Asset identifier for the model in the model catalog." + }, + "lifecycleStatus": { + "type": "string", + "enum": [ + "Stable", + "Preview", + "GenerallyAvailable", + "Deprecating", + "Deprecated", + "Legacy" + ], + "x-ms-enum": { + "name": "ModelLifecycleStatus", + "modelAsString": true, + "values": [ + { + "name": "Stable", + "value": "Stable", + "description": "Legacy state. Replaced with GenerallyAvailable going forward." + }, + { + "name": "Preview", + "value": "Preview", + "description": "Model is in preview and may be subject to changes." + }, + { + "name": "GenerallyAvailable", + "value": "GenerallyAvailable", + "description": "Model is generally available for production use." + }, + { + "name": "Deprecating", + "value": "Deprecating", + "description": "Model is being deprecated and will be removed in the future. Only customers with existing deployments can create new deployments with this model." + }, + { + "name": "Deprecated", + "value": "Deprecated", + "description": "Model has been deprecated, also known as retired, and is no longer supported. Inference calls to deployments of models in this lifecycle state will return 410 errors." + }, + { + "name": "Legacy", + "value": "Legacy", + "description": "Model is a legacy version that is no longer recommended for use. Customers should migrate to newer models. Check replacementConfig for upgrade information." + } + ] + }, + "description": "Model lifecycle status." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentModel" + } + ] + }, + "ModelDeprecationInfo": { + "description": "Cognitive Services account ModelDeprecationInfo.", + "type": "object", + "properties": { + "fineTune": { + "type": "string", + "description": "The datetime of deprecation of the fineTune Model." + }, + "inference": { + "type": "string", + "description": "The datetime of deprecation of the inference Model." + }, + "deprecationStatus": { + "type": "string", + "enum": [ + "Planned", + "Tentative" + ], + "x-ms-enum": { + "name": "DeprecationStatus", + "modelAsString": true + }, + "description": "Indicates whether the deprecation date is a confirmed planned end-of-life date or an estimated deprecation date. When 'Planned', the deprecation date represents a confirmed and communicated model end-of-life date. When 'Tentative', the deprecation date is an estimated timeline that may be subject to change." + } + } + }, + "ReplacementConfig": { + "description": "Configuration for model replacement.", + "type": "object", + "properties": { + "targetModelName": { + "type": "string", + "description": "The name of the replacement model." + }, + "targetModelVersion": { + "type": "string", + "description": "The version of the replacement model." + }, + "autoUpgradeStartDate": { + "type": "string", + "format": "date-time", + "description": "The date when automatic upgrade should start. This applies to deployments with the OnceNewDefaultVersionAvailable upgrade option." + }, + "upgradeOnExpiryLeadTimeDays": { + "type": "integer", + "format": "int32", + "description": "The number of days before deprecation date to trigger upgrade. This applies to deployments with the OnceCurrentVersionExpired upgrade option." + } + } + }, + "ModelCapacityListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of ModelSkuCapacity.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "object", + "readOnly": true, + "properties": { + "location": { + "type": "string", + "description": "The location of the Model Sku Capacity." + }, + "properties": { + "$ref": "#/definitions/ModelSkuCapacityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "x-ms-identifiers": [ + "model" + ], + "description": "Gets the list of Cognitive Services accounts ModelSkuCapacity." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "ModelSkuCapacityProperties": { + "description": "Cognitive Services account ModelSkuCapacity.", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "type": "string" + }, + "availableCapacity": { + "type": "number", + "description": "The available capacity for deployment with this model and sku." + }, + "availableFinetuneCapacity": { + "type": "number", + "description": "The available capacity for deployment with a fine-tune version of this model and sku." + } + } + }, + "PatchResourceTags": { + "description": "The object being used to update tags of a resource, in general used for PATCH operations.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "PatchResourceTagsAndSku": { + "description": "The object being used to update tags and sku of a resource, in general used for PATCH operations.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PatchResourceTags" + } + ] + }, + "RaiMonitorConfig": { + "description": "Cognitive Services Rai Monitor Config.", + "type": "object", + "properties": { + "adxStorageResourceId": { + "type": "string", + "description": "The storage resource Id." + }, + "identityClientId": { + "type": "string", + "description": "The identity client Id to access the storage." + } + } + }, + "RaiPolicyListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiPolicy.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiPolicy" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiPolicy." + } + }, + "description": "The list of cognitive services RaiPolicies." + }, + "RaiPolicy": { + "description": "Cognitive Services RaiPolicy.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiPolicyProperties", + "description": "Properties of Cognitive Services RaiPolicy." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlockListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiBlocklists.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklist" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiBlocklist." + } + }, + "description": "The list of cognitive services RAI Blocklists." + }, + "RaiBlocklist": { + "description": "Cognitive Services RaiBlocklist.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistProperties", + "description": "Properties of Cognitive Services RaiBlocklist." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlocklistProperties": { + "description": "RAI Custom Blocklist properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the block list." + } + } + }, + "RaiBlocklistItemProperties": { + "description": "RAI Custom Blocklist Item properties.", + "type": "object", + "properties": { + "pattern": { + "type": "string", + "description": "Pattern to match against." + }, + "isRegex": { + "type": "boolean", + "description": "If the pattern is a regex pattern." + } + } + }, + "RaiBlockListItemsResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiBlocklistItems.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklistItem" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiBlocklistItems." + } + }, + "description": "The list of cognitive services RAI Blocklist Items." + }, + "RaiBlocklistItemsBulkAddRequest": { + "description": "The list of Cognitive Services RaiBlocklist Items for batch add.", + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklistItemBulkRequest" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "RaiBlocklistItemBulkRequest": { + "description": "The Cognitive Services RaiBlocklist Item request body.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + } + } + }, + "RaiBlocklistItemsBulkDeleteRequest": { + "description": "The list of Cognitive Services RaiBlocklist Items Names.", + "type": "object", + "items": { + "type": "string" + } + }, + "RaiBlocklistItem": { + "description": "Cognitive Services RaiBlocklist Item.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiPolicyProperties": { + "description": "Azure OpenAI Content Filters properties.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "UserManaged", + "SystemManaged" + ], + "x-ms-enum": { + "name": "RaiPolicyType", + "modelAsString": true + }, + "description": "Content Filters policy type.", + "readOnly": true + }, + "mode": { + "type": "string", + "enum": [ + "Default", + "Deferred", + "Blocking", + "Asynchronous_filter" + ], + "x-ms-enum": { + "name": "RaiPolicyMode", + "modelAsString": true + }, + "description": "Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2025-06-01. It is the same as 'Deferred' in previous version." + }, + "basePolicyName": { + "type": "string", + "description": "Name of Rai policy." + }, + "contentFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiPolicyContentFilter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Content Filters." + }, + "customBlocklists": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomBlocklistConfig" + }, + "x-ms-identifiers": [], + "description": "The list of custom Blocklist." + }, + "customTopics": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomTopicConfig" + }, + "x-ms-identifiers": [], + "description": "The list of custom rai topics." + } + } + }, + "CustomBlocklistConfig": { + "description": "Gets or sets the source to which filter applies.", + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RaiBlocklistConfig" + } + ] + }, + "CustomTopicConfig": { + "description": "Gets or sets the source to which filter applies.", + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RaiTopicConfig" + } + ] + }, + "RaiPolicyContentSource": { + "description": "Content source to apply the Content Filters.", + "type": "string", + "enum": [ + "Prompt", + "Completion" + ], + "x-ms-enum": { + "name": "RaiPolicyContentSource", + "modelAsString": true + } + }, + "RaiPolicyContentFilter": { + "description": "Azure OpenAI Content Filter.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of ContentFilter." + }, + "enabled": { + "type": "boolean", + "description": "If the ContentFilter is enabled." + }, + "severityThreshold": { + "description": "Level at which content is filtered.", + "type": "string", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ContentLevel", + "modelAsString": true + } + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + } + }, + "RaiBlocklistConfig": { + "description": "Azure OpenAI blocklist config.", + "type": "object", + "properties": { + "blocklistName": { + "type": "string", + "description": "Name of ContentFilter." + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + } + } + }, + "RaiTopicConfig": { + "description": "Azure OpenAI RAI topic config.", + "type": "object", + "properties": { + "topicName": { + "type": "string", + "description": "Name of RAI topic." + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + } + } + }, + "RaiContentFilterListResult": { + "description": "The list of Content Filters.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Content Filters.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiContentFilter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiContentFilter." + } + } + }, + "RaiContentFilter": { + "description": "Azure OpenAI Content Filter.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Azure OpenAI Content Filter Properties.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Content Filter." + }, + "isMultiLevelFilter": { + "type": "boolean", + "description": "If the Content Filter has multi severity levels(Low, Medium, or High)." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + } + } + } + }, + "RaiTopicResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiTopics.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiTopic" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiTopic." + } + }, + "description": "The list of cognitive services RAI Topics." + }, + "RaiTopic": { + "description": "Cognitive Services Rai Topic.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiTopicProperties", + "description": "Properties of Cognitive Services Rai Topic." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiTopicProperties": { + "description": "RAI Custom Topic properties.", + "type": "object", + "properties": { + "topicId": { + "type": "string", + "description": "The unique identifier of the custom topic." + }, + "topicName": { + "type": "string", + "description": "The name of the custom topic." + }, + "description": { + "type": "string", + "description": "Description of the custom topic." + }, + "sampleBlobUrl": { + "type": "string", + "description": "Sample blob url for the custom topic." + }, + "status": { + "type": "string", + "description": "Status of the custom topic." + }, + "failedReason": { + "type": "string", + "description": "Failed reason if the status is Failed." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Creation time of the custom topic." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "Last modified time of the custom topic." + } + } + }, + "NetworkSecurityPerimeterConfigurationList": { + "description": "A list of NSP configurations for an Cognitive Services account.", + "type": "object", + "properties": { + "value": { + "description": "Array of NSP configurations List Result for an Cognitive Services account.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + }, + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterConfiguration": { + "description": "NSP Configuration for an Cognitive Services account.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties", + "description": "NSP Configuration properties." + } + } + }, + "NetworkSecurityPerimeterConfigurationProperties": { + "description": "The properties of an NSP Configuration.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "description": "Provisioning state of NetworkSecurityPerimeter configuration", + "type": "string" + }, + "provisioningIssues": { + "description": "List of Provisioning Issues", + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningIssue" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "networkSecurityPerimeter": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "resourceAssociation": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationAssociationInfo" + }, + "profile": { + "$ref": "#/definitions/NetworkSecurityPerimeterProfileInfo" + } + } + }, + "ProvisioningIssue": { + "type": "object", + "properties": { + "name": { + "description": "Name of the NSP provisioning issue", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ProvisioningIssueProperties" + } + } + }, + "ProvisioningIssueProperties": { + "description": "Properties of Provisioning Issue", + "type": "object", + "properties": { + "issueType": { + "description": "Type of Issue", + "type": "string" + }, + "severity": { + "description": "Severity of the issue", + "type": "string" + }, + "description": { + "description": "Description of the issue", + "type": "string" + }, + "suggestedResourceIds": { + "description": "IDs of resources that can be associated to the same perimeter to remediate the issue.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource." + } + }, + "suggestedAccessRules": { + "description": "Optional array, suggested access rules", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + } + } + } + }, + "NetworkSecurityPerimeter": { + "description": "Information about a linked Network Security Perimeter", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource", + "type": "string", + "format": "arm-id" + }, + "perimeterGuid": { + "description": "Guid of the resource", + "type": "string" + }, + "location": { + "description": "Location of the resource", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterConfigurationAssociationInfo": { + "description": "Network Security Perimeter Configuration Association Information", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource association", + "type": "string" + }, + "accessMode": { + "description": "Access Mode of the resource association", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterProfileInfo": { + "description": "Network Security Perimeter Profile Information", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource profile", + "type": "string" + }, + "accessRulesVersion": { + "description": "Access rules version of the resource profile", + "type": "integer", + "format": "int64" + }, + "accessRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + }, + "x-ms-identifiers": [] + }, + "diagnosticSettingsVersion": { + "description": "Current diagnostic settings version", + "type": "integer", + "format": "int64" + }, + "enabledLogCategories": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of enabled log categories" + } + } + }, + "NetworkSecurityPerimeterAccessRule": { + "description": "Network Security Perimeter Access Rule", + "type": "object", + "properties": { + "name": { + "description": "Network Security Perimeter Access Rule Name", + "type": "string" + }, + "properties": { + "description": "Properties of Network Security Perimeter Access Rule", + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRuleProperties" + } + } + }, + "NetworkSecurityPerimeterAccessRuleProperties": { + "description": "The Properties of Network Security Perimeter Rule", + "type": "object", + "properties": { + "direction": { + "enum": [ + "Inbound", + "Outbound" + ], + "type": "string", + "description": "Direction of Access Rule", + "x-ms-enum": { + "name": "NspAccessRuleDirection", + "modelAsString": true + } + }, + "addressPrefixes": { + "description": "Address prefixes for inbound rules", + "type": "array", + "items": { + "description": "IP Address", + "type": "string" + } + }, + "subscriptions": { + "description": "Subscriptions for inbound rules", + "type": "array", + "items": { + "description": "Subscription for inbound rule", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of subscription", + "type": "string" + } + } + } + }, + "networkSecurityPerimeters": { + "description": "NetworkSecurityPerimeters for inbound rules", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "fullyQualifiedDomainNames": { + "description": "Fully qualified domain name for outbound rules", + "type": "array", + "items": { + "description": "Fully qualified domain name", + "type": "string" + } + } + } + }, + "DefenderForAISettingResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Defender for AI Settings.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Defender for AI Settings." + } + }, + "description": "The list of cognitive services Defender for AI Settings." + }, + "DefenderForAISetting": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DefenderForAISettingProperties" + } + }, + "description": "The Defender for AI resource." + }, + "DefenderForAISettingProperties": { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "DefenderForAISettingState", + "modelAsString": true + }, + "description": "Defender for AI state on the AI resource." + } + }, + "description": "The Defender for AI resource properties." + }, + "ConnectionPropertiesV2BasicResource": { + "required": [ + "properties" + ], + "description": "Connection base resource schema.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + } + }, + "ConnectionPropertiesV2": { + "required": [ + "authType" + ], + "type": "object", + "description": "Connection property base schema.", + "properties": { + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" + }, + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "createdByWorkspaceArmId": { + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "error": { + "description": "Provides the error message if the connection fails", + "type": "string" + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "group": { + "description": "Group based on connection category", + "$ref": "#/definitions/ConnectionGroup", + "readOnly": true + }, + "isSharedToAll": { + "type": "boolean" + }, + "metadata": { + "description": "Store user metadata for this connection", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "peRequirement": { + "description": "Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'.", + "$ref": "#/definitions/ManagedPERequirement" + }, + "peStatus": { + "description": "Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'.", + "$ref": "#/definitions/ManagedPEStatus" + }, + "sharedUserList": { + "type": "array", + "items": { + "type": "string" + } + }, + "target": { + "description": "The connection URL to be used.", + "type": "string" + }, + "useWorkspaceManagedIdentity": { + "type": "boolean" + } + }, + "discriminator": "authType" + }, + "ConnectionAuthType": { + "description": "Authentication type of the connection target", + "enum": [ + "PAT", + "ManagedIdentity", + "UsernamePassword", + "None", + "SAS", + "AccountKey", + "ServicePrincipal", + "AccessKey", + "ApiKey", + "CustomKeys", + "OAuth2", + "AAD" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionAuthType", + "modelAsString": true + } + }, + "ConnectionCategory": { + "description": "Category of the connection", + "enum": [ + "PythonFeed", + "ContainerRegistry", + "Git", + "S3", + "Snowflake", + "AzureSqlDb", + "AzureSynapseAnalytics", + "AzureMySqlDb", + "AzurePostgresDb", + "ADLSGen2", + "Redis", + "ApiKey", + "AzureOpenAI", + "AIServices", + "CognitiveSearch", + "CognitiveService", + "CustomKeys", + "AzureBlob", + "AzureOneLake", + "CosmosDb", + "CosmosDbMongoDbApi", + "AzureDataExplorer", + "AzureMariaDb", + "AzureDatabricksDeltaLake", + "AzureSqlMi", + "AzureTableStorage", + "AmazonRdsForOracle", + "AmazonRdsForSqlServer", + "AmazonRedshift", + "Db2", + "Drill", + "GoogleBigQuery", + "Greenplum", + "Hbase", + "Hive", + "Impala", + "Informix", + "MariaDb", + "MicrosoftAccess", + "MySql", + "Netezza", + "Oracle", + "Phoenix", + "PostgreSql", + "Presto", + "SapOpenHub", + "SapBw", + "SapHana", + "SapTable", + "Spark", + "SqlServer", + "Sybase", + "Teradata", + "Vertica", + "Pinecone", + "Cassandra", + "Couchbase", + "MongoDbV2", + "MongoDbAtlas", + "AmazonS3Compatible", + "FileServer", + "FtpServer", + "GoogleCloudStorage", + "Hdfs", + "OracleCloudStorage", + "Sftp", + "GenericHttp", + "ODataRest", + "Odbc", + "GenericRest", + "AmazonMws", + "Concur", + "Dynamics", + "DynamicsAx", + "DynamicsCrm", + "GoogleAdWords", + "Hubspot", + "Jira", + "Magento", + "Marketo", + "Office365", + "Eloqua", + "Responsys", + "OracleServiceCloud", + "PayPal", + "QuickBooks", + "Salesforce", + "SalesforceServiceCloud", + "SalesforceMarketingCloud", + "SapCloudForCustomer", + "SapEcc", + "ServiceNow", + "SharePointOnlineList", + "Shopify", + "Square", + "WebTable", + "Xero", + "Zoho", + "GenericContainerRegistry", + "Elasticsearch", + "OpenAI", + "Serp", + "BingLLMSearch", + "Serverless", + "ManagedOnlineEndpoint", + "AzureStorageAccount" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionCategory", + "modelAsString": true + } + }, + "ConnectionGroup": { + "description": "Group based on connection category", + "enum": [ + "Azure", + "AzureAI", + "Database", + "NoSQL", + "File", + "GenericProtocol", + "ServicesAndApps" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionGroup", + "modelAsString": true + } + }, + "ManagedPERequirement": { + "enum": [ + "Required", + "NotRequired", + "NotApplicable" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedPERequirement", + "modelAsString": true + } + }, + "ManagedPEStatus": { + "enum": [ + "Inactive", + "Active", + "NotApplicable" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedPEStatus", + "modelAsString": true + } + }, + "PATAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionPersonalAccessToken" + } + }, + "x-ms-discriminator-value": "PAT" + }, + "ConnectionPersonalAccessToken": { + "type": "object", + "properties": { + "pat": { + "type": "string", + "x-ms-secret": true + } + } + }, + "ManagedIdentityAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionManagedIdentity" + } + }, + "x-ms-discriminator-value": "ManagedIdentity" + }, + "ConnectionManagedIdentity": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "resourceId": { + "type": "string" + } + } + }, + "UsernamePasswordAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionUsernamePassword" + } + }, + "x-ms-discriminator-value": "UsernamePassword" + }, + "ConnectionUsernamePassword": { + "type": "object", + "properties": { + "password": { + "type": "string", + "x-ms-secret": true + }, + "securityToken": { + "description": "Optional, required by connections like SalesForce for extra security in addition to UsernamePassword", + "type": "string", + "x-ms-secret": true + }, + "username": { + "type": "string" + } + } + }, + "NoneAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "None" + }, + "SASAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionSharedAccessSignature" + } + }, + "x-ms-discriminator-value": "SAS" + }, + "ConnectionSharedAccessSignature": { + "type": "object", + "properties": { + "sas": { + "type": "string", + "x-ms-secret": true + } + } + }, + "AccountKeyAuthTypeConnectionProperties": { + "description": "This connection type covers the account key connection for Azure storage", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionAccountKey" + } + }, + "x-ms-discriminator-value": "AccountKey" + }, + "ConnectionAccountKey": { + "description": "Account key object for connection credential.", + "type": "object", + "properties": { + "key": { + "type": "string", + "x-ms-secret": true + } + } + }, + "ServicePrincipalAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionServicePrincipal" + } + }, + "x-ms-discriminator-value": "ServicePrincipal" + }, + "ConnectionServicePrincipal": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string" + }, + "tenantId": { + "type": "string" + } + } + }, + "AccessKeyAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" + }, + "ConnectionAccessKey": { + "type": "object", + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string", + "x-ms-secret": true + } + } + }, + "ApiKeyAuthConnectionProperties": { + "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\r\nAzureOpenAI:\r\n Category:= AzureOpenAI\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {ApiKey} as .ApiKey\r\n Target:= {ApiBase}\r\n \r\nCognitiveService:\r\n Category:= CognitiveService\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {SubscriptionKey} as ApiKey\r\n Target:= ServiceRegion={serviceRegion}\r\n \r\nCognitiveSearch:\r\n Category:= CognitiveSearch\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {Key} as ApiKey\r\n Target:= {Endpoint}\r\n \r\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" + }, + "ConnectionApiKey": { + "description": "Api key object for connection credential.", + "type": "object", + "properties": { + "key": { + "type": "string", + "x-ms-secret": true + } + } + }, + "CustomKeysConnectionProperties": { + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "description": "Custom Keys credential object", + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "CustomKeys": { + "description": "Custom Keys credential object", + "type": "object", + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OAuth2AuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionOAuth2" + } + }, + "x-ms-discriminator-value": "OAuth2" + }, + "ConnectionOAuth2": { + "description": "ClientId and ClientSecret are required. Other properties are optional\r\ndepending on each OAuth2 provider's implementation.", + "type": "object", + "properties": { + "authUrl": { + "description": "Required by Concur connection category", + "type": "string", + "format": "uri" + }, + "clientId": { + "type": "string", + "description": "Client id in the format of UUID", + "format": "uuid" + }, + "clientSecret": { + "type": "string", + "x-ms-secret": true + }, + "developerToken": { + "description": "Required by GoogleAdWords connection category", + "type": "string", + "x-ms-secret": true + }, + "password": { + "type": "string", + "x-ms-secret": true + }, + "refreshToken": { + "description": "Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho\r\nwhere user needs to get RefreshToken offline", + "type": "string", + "x-ms-secret": true + }, + "tenantId": { + "description": "Required by QuickBooks and Xero connection categories", + "type": "string" + }, + "username": { + "description": "Concur, ServiceNow auth server AccessToken grant type is 'Password'\r\nwhich requires UsernamePassword", + "type": "string" + } + } + }, + "AADAuthTypeConnectionProperties": { + "description": "This connection type covers the AAD auth for any applicable Azure service", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "ConnectionUpdateContent": { + "description": "The properties that the Cognitive services connection will be updated with.", + "type": "object", + "properties": { + "properties": { + "description": "The properties that the Cognitive services connection will be updated with.", + "$ref": "#/definitions/ConnectionPropertiesV2" + } + } + }, + "ConnectionPropertiesV2BasicResourceArmPaginatedResult": { + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + } + } + }, + "CapabilityHostResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CapabilityHost" + } + }, + "x-ms-client-name": "CapabilityHost", + "additionalProperties": false + }, + "CapabilityHost": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "aiServicesConnections": { + "description": "List of AI services connections.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "capabilityHostKind": { + "description": "Kind of this capability host.", + "$ref": "#/definitions/CapabilityHostKind" + }, + "customerSubnet": { + "description": "Customer subnet info to help set up this capability host.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the CapabilityHost.", + "$ref": "#/definitions/CapabilityHostProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "storageConnections": { + "description": "List of connection names from those available in the account or project to be used as a storage resource.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "threadStorageConnections": { + "description": "List of connection names from those available in the account or project to be used for Thread storage.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "vectorStoreConnections": { + "description": "List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "x-ms-client-name": "CapabilityHostProperties", + "additionalProperties": false + }, + "CapabilityHostProvisioningState": { + "description": "Provisioning state of capability host.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CapabilityHostProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + }, + { + "value": "Creating" + }, + { + "value": "Updating" + }, + { + "value": "Deleting" + } + ] + }, + "additionalProperties": false + }, + "CapabilityHostKind": { + "enum": [ + "Agents" + ], + "type": "string", + "x-ms-enum": { + "name": "CapabilityHostKind", + "modelAsString": true, + "values": [ + { + "value": "Agents" + } + ] + }, + "additionalProperties": false + }, + "ResourceBase": { + "type": "object", + "properties": { + "description": { + "description": "The asset description text.", + "type": "string", + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NetworkInjection": { + "description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.", + "type": "object", + "properties": { + "scenario": { + "type": "string", + "enum": [ + "none", + "agent" + ], + "x-ms-enum": { + "name": "scenarioType", + "modelAsString": true + }, + "description": "Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection." + }, + "subnetArmId": { + "description": "Specify the subnet for which your Agent Client is injected into.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "useMicrosoftManagedNetwork": { + "description": "Boolean to enable Microsoft Managed Network for subnet delegation", + "type": "boolean" + } + } + }, + "Project": { + "description": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Identity" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/ProjectProperties", + "description": "Properties of Cognitive Services project." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ] + }, + "ProjectProperties": { + "description": "Properties of Cognitive Services Project'.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the cognitive services project at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled", + "ResolvingDNS" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "displayName": { + "type": "string", + "description": "The display name of the Cognitive Services Project." + }, + "description": { + "type": "string", + "description": "The description of the Cognitive Services Project." + }, + "endpoints": { + "readOnly": true, + "type": "object", + "description": "The list of endpoint for this Cognitive Services Project.", + "additionalProperties": { + "type": "string" + } + }, + "isDefault": { + "readOnly": true, + "type": "boolean", + "description": "Indicates whether the project is the default project for the account." + } + } + }, + "ProjectListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of projects.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "description": "Gets the list of Cognitive Services projects and their properties." + } + }, + "description": "The list of cognitive services projects operation response." + }, + "QuotaTier": { + "description": "The quota tier information for the subscription", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/QuotaTierProperties", + "description": "Properties of quota tier resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "QuotaTierProperties": { + "description": "Properties of Quota Tier resource'.", + "type": "object", + "properties": { + "currentTierName": { + "type": "string", + "readOnly": true, + "description": "Name of the current quota tier for the subscription." + }, + "tierUpgradePolicy": { + "type": "string", + "description": "Gets the tier upgrade policy for the subscription.", + "enum": [ + "OnceUpgradeIsAvailable", + "NoAutoUpgrade" + ], + "x-ms-enum": { + "name": "TierUpgradePolicy", + "modelAsString": true + } + }, + "assignmentDate": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The date on which the current tier was assigned to the subscription (UTC)." + }, + "tierUpgradeEligibilityInfo": { + "$ref": "#/definitions/QuotaTierUpgradeEligibilityInfo", + "description": "Information about the quota tier upgrade eligibility for the subscription.", + "readOnly": true, + "x-nullable": true + } + } + }, + "QuotaTierUpgradeEligibilityInfo": { + "description": "Information about the quota tier upgrade eligibility for the subscription.", + "type": "object", + "properties": { + "nextTierName": { + "type": "string", + "x-nullable": true, + "description": "Name of the next quota tier for the subscription." + }, + "upgradeAvailabilityStatus": { + "type": "string", + "description": "Specifies whether an upgrade to the next quota tier is available.", + "enum": [ + "Available", + "NotAvailable" + ], + "x-ms-enum": { + "name": "UpgradeAvailabilityStatus", + "modelAsString": true + } + }, + "upgradeApplicableDate": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "The date after which the current tier will be upgraded to the next tier if the TierUpgradePolicy is \"OnceUpgradeIsAvailable\" (UTC)." + }, + "upgradeUnavailabilityReason": { + "type": "string", + "x-nullable": true, + "description": "Reason in case the subscription is not eligible for upgrade to the next tier." + } + } + }, + "QuotaTierListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of quota tiers.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/QuotaTier" + }, + "x-ms-identifiers": [ + "id" + ], + "description": "Gets the list of Quota Tiers and their properties." + } + }, + "description": "The list of Quota Tiers response." + }, + "FirewallSku": { + "description": "Firewall Sku used for FQDN Rules", + "enum": [ + "Standard", + "Basic" + ], + "type": "string", + "x-ms-enum": { + "name": "FirewallSku", + "modelAsString": true + } + }, + "FqdnOutboundRule": { + "description": "FQDN Outbound Rule for the managed network of a cognitive services account.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "type": "string" + } + }, + "x-ms-discriminator-value": "FQDN" + }, + "IsolationMode": { + "description": "Isolation mode for the managed network of a cognitive services account.", + "enum": [ + "Disabled", + "AllowInternetOutbound", + "AllowOnlyApprovedOutbound" + ], + "type": "string", + "x-ms-enum": { + "name": "IsolationMode", + "modelAsString": true + } + }, + "ManagedNetworkSettings": { + "description": "Managed Network settings for a cognitive services account.", + "type": "object", + "properties": { + "isolationMode": { + "description": "Isolation mode for the managed network of a cognitive services account.", + "$ref": "#/definitions/IsolationMode" + }, + "networkId": { + "type": "string", + "readOnly": true + }, + "outboundRules": { + "type": "object", + "additionalProperties": { + "description": "Outbound Rule for the managed network of a cognitive services account.", + "$ref": "#/definitions/OutboundRule" + }, + "x-nullable": true + }, + "status": { + "description": "Status of the Provisioning for the managed network of a cognitive services account.", + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + }, + "firewallSku": { + "description": "Firewall Sku used for FQDN Rules", + "$ref": "#/definitions/FirewallSku" + }, + "managedNetworkKind": { + "description": "The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled.", + "$ref": "#/definitions/ManagedNetworkKind" + }, + "egressIpAddress": { + "type": "string", + "description": "Public IP address assigned to the Azure Firewall.", + "readOnly": true, + "x-nullable": true + } + } + }, + "ManagedNetworkProvisionOptions": { + "description": "Managed Network Provisioning options for managed network of a cognitive services account.", + "type": "object", + "properties": {} + }, + "ManagedNetworkKind": { + "description": "The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled.", + "enum": [ + "V1", + "V2" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkKind", + "modelAsString": true + } + }, + "ManagedNetworkSettingsBasicResource": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Managed Network settings for a cognitive services account.", + "$ref": "#/definitions/ManagedNetworkSettings" + } + } + }, + "ManagedNetworkStatus": { + "description": "Status for the managed network of a cognitive services account.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } + }, + "ManagedNetworkProvisionStatus": { + "description": "Status of the Provisioning for the managed network of a cognitive services account.", + "type": "object", + "properties": { + "status": { + "description": "Status for the managed network of a cognitive services account.", + "$ref": "#/definitions/ManagedNetworkStatus" + } + } + }, + "ManagedNetworkListResult": { + "description": "List of managed networks of a cognitive services account.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of managed network settings of an account. Since this list may be incomplete, the nextLink field should be used to request the next list of cognitive services accounts.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + } + } + }, + "ManagedNetworkSettingsEx": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedNetworkSettings" + } + ], + "properties": { + "changeableIsolationModes": { + "type": "array", + "items": { + "$ref": "#/definitions/IsolationMode" + }, + "readOnly": true + } + } + }, + "ManagedNetworkSettingsProperties": { + "description": "The properties of the managed network settings of a cognitive services account.", + "type": "object", + "properties": { + "managedNetwork": { + "description": "Managed Network settings for a cognitive services account.", + "$ref": "#/definitions/ManagedNetworkSettingsEx" + }, + "provisioningState": { + "description": "The current deployment state of the managed network resource. The provisioningState is to indicate states for resource provisioning.", + "$ref": "#/definitions/ManagedNetworkProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "ManagedNetworkProvisioningState": { + "enum": [ + "Deferred", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Deleted" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "ManagedNetworkSettingsPropertiesBasicResource": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of the managed network settings of a cognitive services account.", + "$ref": "#/definitions/ManagedNetworkSettingsProperties" + } + } + }, + "OutboundRule": { + "description": "Outbound Rule for the managed network of a cognitive services account.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "description": "Category of a managed network Outbound Rule of a cognitive services account.", + "$ref": "#/definitions/RuleCategory" + }, + "status": { + "description": "Type of a managed network Outbound Rule of a cognitive services account.", + "$ref": "#/definitions/RuleStatus" + }, + "type": { + "description": "Type of a managed network Outbound Rule of a cognitive services account.", + "$ref": "#/definitions/RuleType" + }, + "errorInformation": { + "description": "Error information about an outbound rule of a cognitive services account if RuleStatus is failed.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "parentRuleNames": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "type" + }, + "OutboundRuleBasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Outbound Rule for the managed network of a cognitive services account.", + "$ref": "#/definitions/OutboundRule" + } + } + }, + "OutboundRuleListResult": { + "description": "List of outbound rules for the managed network of a cognitive services account.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of cognitive services accounts. Since this list may be incomplete, the nextLink field should be used to request the next list of cognitive services accounts.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + } + }, + "RuleCategory": { + "description": "Category of a managed network Outbound Rule of a cognitive services account.", + "enum": [ + "Required", + "Recommended", + "UserDefined", + "Dependency" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true + } + }, + "RuleStatus": { + "description": "Type of a managed network Outbound Rule of a cognitive services account.", + "enum": [ + "Inactive", + "Active", + "Provisioning", + "Deleting", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true + } + }, + "RuleType": { + "description": "Type of a managed network Outbound Rule of a cognitive services account.", + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "AgentApplicationResource": { + "description": "Agent Application resource", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/AgenticApplication" + } + }, + "x-ms-client-name": "AgentApplication", + "additionalProperties": false + }, + "AgentApplicationResourceArmPaginatedResult": { + "description": "A paginated list of Agent Application entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Agent Application objects. If null, there are no additional pages.", + "type": "string", + "x-nullable": true + }, + "value": { + "description": "An array of objects of type Agent Application.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentApplicationResource" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AgentDefinitionResource": { + "description": "Agent Definition resource", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/AgentDefinition" + } + }, + "x-ms-client-name": "AgentDefinition", + "additionalProperties": false + }, + "AgentDefinitionResourceArmPaginatedResult": { + "description": "A paginated list of Agent Definition entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Agent Definition objects. If null, there are no additional pages.", + "type": "string", + "x-nullable": true + }, + "value": { + "description": "An array of objects of type Agent Definition.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDefinitionResource" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AgentDeploymentResource": { + "description": "Agent Deployment resource", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/AgentDeployment" + } + }, + "x-ms-client-name": "AgentDeployment", + "additionalProperties": false + }, + "AgentDeploymentResourceArmPaginatedResult": { + "description": "A paginated list of Agent Deployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Agent Deployment objects. If null, there are no additional pages.", + "type": "string", + "x-nullable": true + }, + "value": { + "description": "An array of objects of type Agent Deployment.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDeploymentResource" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AgenticApplication": { + "description": "Resource type representing an agentic application as a management construct.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "description": { + "description": "The description of the application.", + "type": "string", + "x-nullable": true + }, + "displayName": { + "description": "The display name of the application.", + "type": "string", + "x-nullable": true + }, + "baseUri": { + "description": "The application's unique resource identifier.", + "type": "string", + "x-nullable": true + }, + "associatedResourceId": { + "description": "The resource ID of the account or project associated with this application.", + "type": "string", + "x-nullable": true + }, + "agents": { + "description": "The list of agent definitions comprising this application, returned as references to the objects under the parent project.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentReference" + }, + "x-nullable": true + }, + "deployments": { + "description": "The list of agent deployments of this application.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDeployment" + }, + "x-nullable": true + }, + "applicationIdentity": { + "description": "The blueprint identity of the application.", + "$ref": "#/definitions/AssignedIdentity", + "x-nullable": true + }, + "instanceIdentity": { + "description": "The instance identity of the application.", + "$ref": "#/definitions/AssignedIdentity", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state of the application.", + "$ref": "#/definitions/AgenticApplicationProvisioningState", + "readOnly": true + } + }, + "additionalProperties": false + }, + "AgentDefinition": { + "description": "Agent Definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "agentId": { + "description": "Unique identifier for the agent.", + "type": "string", + "x-nullable": true + }, + "name": { + "description": "Name of the agent.", + "type": "string", + "x-nullable": true + }, + "version": { + "description": "Version of the agent.", + "type": "string", + "x-nullable": true + }, + "capabilities": { + "description": "Capabilities of the agent.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "modelReference": { + "description": "Reference to the underlying model used by the agent.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AgentDeployment": { + "description": "Agent Deployment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "deploymentId": { + "description": "Unique identifier for the deployment.", + "type": "string", + "x-nullable": true + }, + "agentId": { + "description": "Identifier of the agent being deployed.", + "type": "string", + "x-nullable": true + }, + "environment": { + "description": "Deployment environment (e.g., development, staging, production).", + "type": "string", + "x-nullable": true + }, + "status": { + "description": "Status of the deployment.", + "type": "string", + "x-nullable": true + }, + "endpoint": { + "description": "Endpoint information for the deployed agent.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AgentReference": { + "description": "Reference to an agent definition", + "type": "object", + "properties": { + "agentId": { + "description": "Unique identifier for the agent.", + "type": "string", + "x-nullable": true + }, + "version": { + "description": "Version of the agent.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AgenticApplicationProvisioningState": { + "description": "Provisioning state of an agentic application.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "AgenticApplicationProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The application was successfully provisioned." + }, + { + "value": "Failed", + "description": "The application provisioning failed." + }, + { + "value": "Canceled", + "description": "The application provisioning was canceled." + }, + { + "value": "Creating", + "description": "The application is being created." + }, + { + "value": "Updating", + "description": "The application is being updated." + }, + { + "value": "Deleting", + "description": "The application is being deleted." + } + ] + } + }, + "AssignedIdentity": { + "description": "Type representing an identity assignment", + "type": "object", + "required": [ + "identityKind", + "identityType", + "principalId", + "tenantId" + ], + "properties": { + "identityKind": { + "description": "Specifies the kind of Entra identity described by this object.", + "$ref": "#/definitions/IdentityKind" + }, + "identityType": { + "description": "Enumeration of identity types, from the perspective of management.", + "$ref": "#/definitions/IdentityType" + }, + "principalId": { + "description": "The principal ID of the identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant ID of the identity.", + "type": "string" + }, + "subject": { + "description": "The subject of this identity assignment.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Represents the provisioning state of an identity resource.", + "$ref": "#/definitions/IdentityProvisioningState", + "readOnly": true + } + }, + "additionalProperties": false + }, + "IdentityKind": { + "description": "Specifies the kind of Entra identity described by this object.", + "type": "string", + "enum": [ + "AgentBlueprint", + "AgentInstance", + "AgenticUser", + "Managed", + "None" + ], + "x-ms-enum": { + "name": "IdentityKind", + "modelAsString": true, + "values": [ + { + "value": "AgentBlueprint", + "description": "Represents a class identity, used for agentic applications." + }, + { + "value": "AgentInstance", + "description": "Represents an instance identity." + }, + { + "value": "AgenticUser", + "description": "Represents an agentic instance identity with user-like traits." + }, + { + "value": "Managed", + "description": "Represents a classic managed identity." + }, + { + "value": "None", + "description": "No identity." + } + ] + } + }, + "IdentityType": { + "description": "Enumeration of identity types, from the perspective of management.", + "type": "string", + "enum": [ + "System", + "User", + "None" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "Platform-managed identity." + }, + { + "value": "User", + "description": "User-managed identity." + }, + { + "value": "None", + "description": "No identity." + } + ] + } + }, + "IdentityProvisioningState": { + "description": "Represents the provisioning state of an identity resource.", + "type": "string", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "IdentityProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating", + "description": "Identity is being created." + }, + { + "value": "Updating", + "description": "Identity is being updated." + }, + { + "value": "Succeeded", + "description": "Identity has been successfully provisioned." + }, + { + "value": "Failed", + "description": "Identity provisioning has failed." + }, + { + "value": "Canceled", + "description": "Identity provisioning has been canceled." + }, + { + "value": "Deleting", + "description": "Identity is being deleted." + } + ] + } + }, + "AgentCard": { + "description": "Represents a detailed description of an agent, including its name, functionality, hosting information, supported interaction modes, and available skills.", + "type": "object", + "properties": { + "name": { + "description": "Human-readable name for the Agent (e.g., 'Recipe Agent').", + "type": "string", + "x-nullable": true + }, + "description": { + "description": "Human-readable description of the Agent's function.", + "type": "string", + "x-nullable": true + }, + "url": { + "description": "URL address where the Agent is hosted.", + "type": "string", + "x-nullable": true + }, + "provider": { + "description": "Service provider information for the Agent.", + "$ref": "#/definitions/ProviderInfo", + "x-nullable": true + }, + "version": { + "description": "Version of the Agent (format defined by provider, e.g., '1.0.0').", + "type": "string", + "x-nullable": true + }, + "documentationUrl": { + "description": "URL for the Agent's documentation.", + "type": "string", + "x-nullable": true + }, + "defaultInputModes": { + "description": "Default interaction modes supported by the Agent across all skills.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "defaultOutputModes": { + "description": "Default output modes supported by the Agent across all skills.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "skills": { + "description": "Collection of capability units the Agent can perform.", + "type": "array", + "items": { + "$ref": "#/definitions/Skill" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ProviderInfo": { + "description": "Service provider information for the Agent", + "type": "object", + "properties": { + "organization": { + "description": "Organization name of the provider.", + "type": "string", + "x-nullable": true + }, + "url": { + "description": "URL of the provider.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Skill": { + "description": "Collection of capability units the Agent can perform", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the skill.", + "type": "string", + "x-nullable": true + }, + "name": { + "description": "Human-readable name for the skill.", + "type": "string", + "x-nullable": true + }, + "description": { + "description": "Skill description.", + "type": "string", + "x-nullable": true + }, + "tags": { + "description": "Tags describing the skill's capability category (e.g., 'cooking', 'customer support').", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "examples": { + "description": "Example scenarios or prompts the skill can execute (e.g., 'I need a recipe for bread').", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "inputModes": { + "description": "Input MIME types supported by the skill (if different from default).", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "outputModes": { + "description": "Output MIME types supported by the skill (if different from default).", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "additionalProperties": false + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of Cognitive Services account.", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "Resource location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "usageFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "deploymentNameParameter": { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiPolicyNameParameter": { + "name": "raiPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiBlocklistNameParameter": { + "name": "raiBlocklistName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiBlocklistItemNameParameter": { + "name": "raiBlocklistItemName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiBlocklist Item associated with the custom blocklist", + "x-ms-parameter-location": "method" + }, + "raiTopicNameParameter": { + "name": "raiTopicName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Rai Topic associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "commitmentPlanNameParameter": { + "name": "commitmentPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "commitmentPlanResourceNameParameter": { + "name": "commitmentPlanName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "commitmentPlanAssociationNameParameter": { + "name": "commitmentPlanAssociationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the commitment plan association with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "encryptionScopeNameParameter": { + "name": "encryptionScopeName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the encryptionScope associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "modelFormatFilterParameter": { + "name": "modelFormat", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The format of the Model", + "x-ms-parameter-location": "method" + }, + "modelNameFilterParameter": { + "name": "modelName", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Model", + "x-ms-parameter-location": "method" + }, + "modelVersionFilterParameter": { + "name": "modelVersion", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The version of the Model", + "x-ms-parameter-location": "method" + }, + "defenderForAISettingNameParameter": { + "name": "defenderForAISettingName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the defender for AI setting.", + "x-ms-parameter-location": "method" + }, + "nspConfigurationNameParameter": { + "name": "nspConfigurationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.*$", + "description": "The name of the NSP Configuration.", + "x-ms-parameter-location": "method" + }, + "raiContentFilterNameParameter": { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RAI Content Filter.", + "x-ms-parameter-location": "method" + }, + "projectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of Cognitive Services account's project.", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "in": "path", + "name": "connectionName", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "description": "Target of the connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "description": "Category of the connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "capabilityHostNameParameter": { + "name": "capabilityHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capability host associated with the Cognitive Services Resource", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + "defaultParameter": { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default parameter. Leave the value as \"default\".", + "x-ms-parameter-location": "method" + }, + "ManagedNetworkNameParameter": { + "in": "path", + "name": "managedNetworkName", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "RuleName": { + "in": "path", + "name": "ruleName", + "description": "Name of the cognitive services account managed network outbound rule", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/createOrUpdate.json new file mode 100644 index 000000000000..5883862d3f50 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/createOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "capabilityHostName": "capabilityHostName", + "api-version": "2025-10-01-preview", + "capabilityHost": { + "properties": { + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/delete.json new file mode 100644 index 000000000000..1372258b0543 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "capabilityHostName": "capabilityHostName", + "api-version": "2025-10-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "location_header_to_poll" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/get.json new file mode 100644 index 000000000000..a367cd7eb277 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "capabilityHostName": "capabilityHostName", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/create.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/create.json new file mode 100644 index 000000000000..1444bd107147 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview", + "connection": { + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "None" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "None" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/delete.json new file mode 100644 index 000000000000..c3db142431b1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/get.json new file mode 100644 index 000000000000..2c7f49c29b56 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "None" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/list.json new file mode 100644 index 000000000000..51481e1458ed --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/list.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "api-version": "2025-10-01-preview", + "target": "[tartget url]", + "category": "ContainerRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/linkedaccounts/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "PAT" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/linkedaccounts/connection-2", + "name": "connection-2", + "type": "Microsoft.CognitiveServices/accounts/connections", + "properties": { + "category": "ContainerRegistry", + "target": "[tartget url]", + "authType": "PAT" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/update.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/update.json new file mode 100644 index 000000000000..5d90b49236c1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountConnection/update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview", + "connection": { + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AddRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AddRaiBlocklistItems.json new file mode 100644 index 000000000000..0d1301387881 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AddRaiBlocklistItems.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "myblocklist", + "raiBlocklistItems": [ + { + "name": "myblocklistitem1", + "properties": { + "pattern": "^[a-z0-9_-]{2,16}$", + "isRegex": true + } + }, + { + "name": "myblocklistitem2", + "properties": { + "pattern": "blockwords", + "isRegex": false + } + } + ] + }, + "responses": { + "200": { + "body": { + "name": "myblocklist", + "properties": { + "description": "Brief description of the blocklist" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/createOrUpdate.json new file mode 100644 index 000000000000..bbb432897174 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/createOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "my-cognitive-services-account", + "projectName": "my-project", + "name": "agent-app-1", + "api-version": "2025-10-01-preview", + "body": { + "properties": { + "description": "Sample agent application for customer support", + "tags": { + "environment": "production", + "team": "ai-platform" + }, + "displayName": "Customer Support Agent" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "properties": { + "description": "Sample agent application for customer support", + "tags": { + "environment": "production", + "team": "ai-platform" + }, + "displayName": "Customer Support Agent", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "properties": { + "description": "Sample agent application for customer support", + "tags": { + "environment": "production", + "team": "ai-platform" + }, + "displayName": "Customer Support Agent", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/delete.json new file mode 100644 index 000000000000..6094d22dd7af --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "my-cognitive-services-account", + "projectName": "my-project", + "name": "agent-app-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/get.json new file mode 100644 index 000000000000..6b51e9f2b2be --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "my-cognitive-services-account", + "projectName": "my-project", + "name": "agent-app-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "properties": { + "description": "Sample agent application for customer support", + "tags": { + "environment": "production", + "team": "ai-platform" + }, + "displayName": "Customer Support Agent" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/list.json new file mode 100644 index 000000000000..42229b618c08 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/list.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "my-cognitive-services-account", + "projectName": "my-project", + "api-version": "2025-10-01-preview", + "$skipToken": "string", + "count": 30, + "names": [ + "agent-app-1", + "agent-app-2" + ], + "searchText": "test", + "orderBy": "name", + "orderByAsc": true + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "properties": { + "description": "Sample agent application for customer support", + "tags": { + "environment": "production", + "team": "ai-platform" + }, + "displayName": "Customer Support Agent" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listAgents.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listAgents.json new file mode 100644 index 000000000000..da49389c5a8c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listAgents.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "my-cognitive-services-account", + "projectName": "my-project", + "name": "agent-app-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agents/agent-001", + "name": "agent-001", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agents", + "properties": { + "tags": { + "role": "primary", + "language": "multi" + }, + "agentId": "agent-001", + "name": "CustomerSupportAgent", + "version": "1.2.0", + "capabilities": [ + "natural-language-processing", + "sentiment-analysis", + "multi-language-support", + "knowledge-base-query" + ], + "modelReference": "gpt-4-turbo-preview" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agents/agent-002", + "name": "agent-002", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agents", + "properties": { + "tags": { + "role": "technical", + "specialization": "complex-queries" + }, + "agentId": "agent-002", + "name": "TechnicalSupportAgent", + "version": "1.1.0", + "capabilities": [ + "technical-documentation", + "code-analysis", + "troubleshooting", + "escalation-handling" + ], + "modelReference": "gpt-4-turbo-preview" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listDeployments.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listDeployments.json new file mode 100644 index 000000000000..5d3e641d4b98 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listDeployments.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "my-cognitive-services-account", + "projectName": "my-project", + "name": "agent-app-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deploy-001", + "name": "deploy-001", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "properties": { + "description": "Production deployment for customer support agents", + "tags": { + "environment": "production", + "region": "eastus" + }, + "deploymentId": "deploy-001", + "agentId": "agent-001", + "environment": "production", + "status": "Running", + "endpoint": "https://eastus.api.azureml.ms/agents/agent-001" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deploy-002", + "name": "deploy-002", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "properties": { + "description": "Staging deployment for testing new features", + "tags": { + "environment": "staging", + "region": "westus" + }, + "deploymentId": "deploy-002", + "agentId": "agent-002", + "environment": "staging", + "status": "Running", + "endpoint": "https://westus.api.azureml.ms/agents/agent-002" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CalculateModelCapacity.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CalculateModelCapacity.json new file mode 100644 index 000000000000..eab4343ac21c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CalculateModelCapacity.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "parameters": { + "model": { + "format": "OpenAI", + "name": "gpt-4", + "version": "0613" + }, + "skuName": "ProvisionedManaged", + "workloads": [ + { + "requestPerMinute": 10, + "requestParameters": { + "avgPromptTokens": 30, + "avgGeneratedTokens": 50 + } + }, + { + "requestPerMinute": 20, + "requestParameters": { + "avgPromptTokens": 60, + "avgGeneratedTokens": 20 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "model": { + "format": "OpenAI", + "name": "gpt-4", + "version": "0613" + }, + "skuName": "ProvisionedManaged", + "estimatedCapacity": { + "value": 346, + "deployableValue": 400 + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CheckDomainAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CheckDomainAvailability.json new file mode 100644 index 000000000000..aa31e9654aed --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CheckDomainAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "location": "westus", + "parameters": { + "subdomainName": "contosodemoapp1", + "type": "Microsoft.CognitiveServices/accounts" + } + }, + "responses": { + "200": { + "body": { + "isSubdomainAvailable": false, + "reason": "Sub domain name 'contosodemoapp1' is not valid", + "subdomainName": "contosodemoapp1", + "type": "Microsoft.CognitiveServices/accounts" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CheckSkuAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CheckSkuAvailability.json new file mode 100644 index 000000000000..e5c0c4387e63 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CheckSkuAvailability.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "location": "westus", + "parameters": { + "skus": [ + "S0" + ], + "kind": "Face", + "type": "Microsoft.CognitiveServices/accounts" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "Face", + "type": "Microsoft.CognitiveServices/accounts", + "skuName": "S0", + "skuAvailable": true, + "reason": null, + "message": null + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateAccount.json new file mode 100644 index 000000000000..f3236e8ef1ac --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateAccount.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "account": { + "location": "West US", + "kind": "Emotion", + "sku": { + "name": "S0" + }, + "properties": { + "encryption": { + "keyVaultProperties": { + "keyName": "KeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + }, + "keySource": "Microsoft.KeyVault" + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateAccountMin.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateAccountMin.json new file mode 100644 index 000000000000..405da3ab4a3e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateAccountMin.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "account": { + "location": "West US", + "kind": "CognitiveServices", + "sku": { + "name": "S0" + }, + "properties": {}, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateOrUpdateQuotaTier.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateOrUpdateQuotaTier.json new file mode 100644 index 000000000000..451b3b755a01 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateOrUpdateQuotaTier.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-00000-0000-0000-000000000000", + "default": "default", + "tier": { + "properties": { + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-00000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "properties": { + "currentTierName": "Free-Tier", + "assignmentDate": "2025-06-09T18:13:29.389Z", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-00000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "properties": { + "currentTierName": "Free-Tier", + "assignmentDate": "2025-06-09T18:13:29.389Z", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateProject.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateProject.json new file mode 100644 index 000000000000..f6006b82acdd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateProject.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "projectName": "testProject1", + "project": { + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "West US", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "provisioningState": "Succeeded", + "endpoints": { + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "West US", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "provisioningState": "Succeeded", + "endpoints": { + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "West US", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "provisioningState": "Succeeded", + "endpoints": { + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateProjectMin.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateProjectMin.json new file mode 100644 index 000000000000..a40d22d4a613 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateProjectMin.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "projectName": "testProject1", + "project": { + "location": "West US", + "properties": {}, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "West US", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": { + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "West US", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": { + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "West US", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": { + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateSharedCommitmentPlan.json new file mode 100644 index 000000000000..7035de4183db --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateSharedCommitmentPlan.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "location": "West US", + "kind": "SpeechServices", + "sku": { + "name": "S0" + }, + "properties": { + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..2c33ed8dadce --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/CreateSharedCommitmentPlanAssociation.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "association": { + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteAccount.json new file mode 100644 index 000000000000..3bd7071352f7 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteAccount.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "PropTest01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteCommitmentPlan.json new file mode 100644 index 000000000000..1ae166933a29 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteCommitmentPlan.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteDeployment.json new file mode 100644 index 000000000000..a5253aa15556 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteEncryptionScope.json new file mode 100644 index 000000000000..bcc65174b04c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteEncryptionScope.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeletePrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..57c67930fe1d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeletePrivateEndpointConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2025-10-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteProject.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteProject.json new file mode 100644 index 000000000000..3d3d99281e36 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteProject.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "PropTest01", + "projectName": "myProject" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklist.json new file mode 100644 index 000000000000..fa16854c00a3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklist.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklistItem.json new file mode 100644 index 000000000000..21646e78fd6d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklistItem.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklistItems.json new file mode 100644 index 000000000000..d62a672ae343 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiBlocklistItems.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemsNames": [ + "myblocklistitem1", + "myblocklistitem2" + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiPolicy.json new file mode 100644 index 000000000000..4ef73c56c400 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiPolicyName": "raiPolicyName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiTopic.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiTopic.json new file mode 100644 index 000000000000..2473a40b461a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteRaiTopic.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiTopicName": "raiTopicName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteSharedCommitmentPlan.json new file mode 100644 index 000000000000..0e64de2b694e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteSharedCommitmentPlan.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..6391c4e40830 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/DeleteSharedCommitmentPlanAssociation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetAccount.json new file mode 100644 index 000000000000..561b4ebe7328 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetAccount.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetCommitmentPlan.json new file mode 100644 index 000000000000..f58f25b2bcc4 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetCommitmentPlan.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDefenderForAISetting.json new file mode 100644 index 000000000000..54adda8c1cc5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDefenderForAISetting.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDeletedAccount.json new file mode 100644 index 000000000000..d6373dc68c81 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDeletedAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/resourceGroups/myResourceGroup/deletedAccounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDeployment.json new file mode 100644 index 000000000000..8171e113e742 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetDeployment.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetEncryptionScope.json new file mode 100644 index 000000000000..7ef0661c80b8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetEncryptionScope.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName" + }, + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..c0878834e64f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "nspConfigurationName": "NSPConfigurationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetOperations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetOperations.json new file mode 100644 index 000000000000..2dc87e5f981d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CognitiveServices/accounts/read", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Read API Account", + "description": "Reads API accounts." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/write", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Write API Account", + "description": "Writes API Accounts." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/delete", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Delete API Account", + "description": "Deletes API accounts" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..0291fd9c6016 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2025-10-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetProject.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetProject.json new file mode 100644 index 000000000000..f1c1c866cfe8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetProject.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject", + "name": "myProject", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "westus", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "provisioningState": "Succeeded", + "displayName": "myProject", + "description": "This is my project", + "endpoints": { + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetQuotaTier.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetQuotaTier.json new file mode 100644 index 000000000000..c7225b8e0709 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetQuotaTier.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "default": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "properties": { + "currentTierName": "Free-Tier", + "assignmentDate": "2025-06-09T18:13:29.389Z", + "tierUpgradePolicy": "OnceUpgradeIsAvailable", + "tierUpgradeEligibilityInfo": { + "nextTierName": "Tier-1", + "upgradeAvailabilityStatus": "Available", + "upgradeApplicableDate": "2025-06-15T18:13:29.389Z" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiBlocklist.json new file mode 100644 index 000000000000..ac1da7621412 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiBlocklist.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiBlocklistItem.json new file mode 100644 index 000000000000..c5325ed640fc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiBlocklistItem.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName" + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiContentFilter.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiContentFilter.json new file mode 100644 index 000000000000..9ad0b3237227 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiContentFilter.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS", + "filterName": "IndirectAttack" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiPolicy.json new file mode 100644 index 000000000000..ecbfbffc8206 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiPolicy.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "raiPolicyName": "raiPolicyName", + "effective": true + }, + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "Protected Material Text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Protected Material Code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiTopic.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiTopic.json new file mode 100644 index 000000000000..7d353244cfa2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetRaiTopic.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiTopicName": "raiTopicName" + }, + "responses": { + "200": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "topicName": "raiTopicName", + "topicId": "00000000-0000-0000-0000-000000000000", + "description": "This is a sample topic.", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Succeeded", + "failedReason": null, + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSharedCommitmentPlan.json new file mode 100644 index 000000000000..8f40cec7c25e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSharedCommitmentPlan.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..765b1aba050c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSharedCommitmentPlanAssociation.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSkus.json new file mode 100644 index 000000000000..0d5b436513ff --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetSkus.json @@ -0,0 +1,2164 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "f1c637e4-72ec-4f89-8d2b-0f933c036002" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S5", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S6", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S7", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S8", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.Autosuggest.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.CustomSearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.SpellCheck.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetUsages.json new file mode 100644 index 000000000000..a9ac4eafe618 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/GetUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3", + "resourceGroupName": "myResourceGroup", + "accountName": "TestUsage02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "Face.Transactions", + "localizedValue": "Face.Transactions" + }, + "status": "Included", + "currentValue": 3, + "limit": 30000, + "nextResetTime": "2018-03-28T09:33:51Z", + "quotaPeriod": "30.00:00:00", + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountModels.json new file mode 100644 index 000000000000..6d178afcad9e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountModels.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "location": "location", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "baseModel": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "format": "OpenAI", + "name": "ada.1", + "version": "1", + "isDefaultVersion": false, + "maxCapacity": 10, + "capabilities": { + "fineTune": "true", + "inference": "false", + "completion": "true" + }, + "deprecation": { + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z", + "deprecationStatus": "Planned" + }, + "lifecycleStatus": "Legacy", + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-10-07T00:00:00Z" + } + }, + { + "format": "OpenAI", + "name": "dall-e-3", + "version": "3.0", + "isDefaultVersion": true, + "maxCapacity": 2, + "capabilities": { + "inference": "true", + "imageGenerations": "true" + }, + "deprecation": { + "inference": "2025-06-30T00:00:00Z", + "deprecationStatus": "Tentative" + }, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/dall-e-3/versions/3.0", + "lifecycleStatus": "GenerallyAvailable", + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2023-08-11T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application", + "lastModifiedAt": "2023-08-11T00:00:00Z" + } + }, + { + "format": "OpenAI", + "name": "gpt-35-turbo", + "version": "0301", + "isDefaultVersion": false, + "maxCapacity": 9, + "capabilities": { + "fineTune": "false", + "scaleType": "Manual,Standard", + "completion": "true", + "chatCompletion": "true" + }, + "deprecation": { + "inference": "2025-04-30T00:00:00Z", + "deprecationStatus": "Planned" + }, + "lifecycleStatus": "Deprecated", + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2023-03-09T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application", + "lastModifiedAt": "2023-07-06T00:00:00Z" + } + }, + { + "format": "OpenAI", + "name": "gpt-4o", + "version": "2024-05-13", + "maxCapacity": 50, + "capabilities": { + "fineTune": "false", + "inference": "true", + "completion": "true", + "chat": "true", + "vision": "true" + }, + "deprecation": { + "inference": "2025-09-15T00:00:00Z", + "deprecationStatus": "Tentative" + }, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-05-13", + "lifecycleStatus": "Deprecating", + "replacementConfig": { + "targetModelName": "gpt-4.1", + "targetModelVersion": "2025-04-14", + "autoUpgradeStartDate": "2025-03-26T07:00:00Z", + "upgradeOnExpiryLeadTimeDays": 7 + }, + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2024-05-13T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application", + "lastModifiedAt": "2024-12-15T00:00:00Z" + } + }, + { + "format": "Meta", + "name": "Llama-3.2-90B-Vision-Instruct", + "version": "2", + "isDefaultVersion": false, + "maxCapacity": 3, + "capabilities": { + "chatCompletion": "true" + }, + "deprecation": { + "inference": "2099-12-31T00:00:00Z", + "deprecationStatus": "Tentative" + }, + "modelCatalogAssetId": "azureml://registries/azureml-meta/models/Llama-3.2-90B-Vision-Instruct/versions/2", + "lifecycleStatus": "Stable", + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2024-10-01T00:00:00Z", + "lastModifiedBy": "MaaSModelConverter", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-16T04:45:33.9367873Z" + } + }, + { + "format": "OpenAI", + "name": "gpt-4o", + "version": "2024-08-06", + "maxCapacity": 50, + "capabilities": { + "fineTune": "false", + "inference": "true", + "completion": "true", + "chat": "true", + "vision": "true", + "functionCalling": "true" + }, + "finetuneCapabilities": { + "fineTune": "true", + "inference": "true", + "scaleType": "Manual", + "completion": "true", + "chat": "true" + }, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-08-06", + "lifecycleStatus": "GenerallyAvailable", + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2024-08-06T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application", + "lastModifiedAt": "2024-11-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountsByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..575e332c04c6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/TestPropertyWU2", + "name": "TestPropertyWU2", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "tags": {}, + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..c94b74c71777 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListAccountsBySubscription.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S1" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "CRIS", + "tags": { + "can't delete it successfully": "v-yunjin" + }, + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListBlocklistItems.json new file mode 100644 index 000000000000..e37f8f1bdfb3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListBlocklistItems.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + }, + { + "name": "raiBlocklistItemName2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName2", + "properties": { + "pattern": "Another Pattern To Block", + "isRegex": false + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListBlocklists.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListBlocklists.json new file mode 100644 index 000000000000..8744ff1e0ecb --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListBlocklists.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListCommitmentPlans.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListCommitmentPlans.json new file mode 100644 index 000000000000..eaecbd8397fc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListCommitmentPlans.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListCommitmentTiers.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListCommitmentTiers.json new file mode 100644 index 000000000000..3981fad86951 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListCommitmentTiers.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "location": "location" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "TextAnalytics", + "skuName": "S", + "hostingModel": "Web", + "planType": "TA", + "tier": "T1", + "quota": { + "quantity": 1000000, + "unit": "Transaction" + }, + "cost": {} + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDefenderForAISetting.json new file mode 100644 index 000000000000..90d8b4b4fe13 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDefenderForAISetting.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeletedAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeletedAccountsBySubscription.json new file mode 100644 index 000000000000..c94b74c71777 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeletedAccountsBySubscription.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S1" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "CRIS", + "tags": { + "can't delete it successfully": "v-yunjin" + }, + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeploymentSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeploymentSkus.json new file mode 100644 index 000000000000..5cba14086158 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeploymentSkus.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "capacity": { + "minimum": 100, + "maximum": 1000, + "step": 100, + "default": 100, + "allowedValues": [ + 100, + 200 + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeployments.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeployments.json new file mode 100644 index 000000000000..1963995ac220 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListDeployments.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListEncryptionScopes.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListEncryptionScopes.json new file mode 100644 index 000000000000..66babcc7fe7f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListEncryptionScopes.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListKeys.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListKeys.json new file mode 100644 index 000000000000..c107d9b7ee54 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListLocationBasedModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListLocationBasedModelCapacities.json new file mode 100644 index 000000000000..6abd64fe57b7 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListLocationBasedModelCapacities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "name": "Standard", + "location": "WestUS", + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "skuName": "Standard", + "availableCapacity": 300, + "availableFinetuneCapacity": 20 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListLocationModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListLocationModels.json new file mode 100644 index 000000000000..e77c80c13618 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListLocationModels.json @@ -0,0 +1,290 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "OpenAI", + "skuName": "S0", + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1", + "maxCapacity": 3, + "capabilities": { + "inference": "false", + "scaleType": "Manual", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValuePerExample": "4096", + "FineTuneTokensMaxValue": "2000000000" + }, + "deprecation": { + "fineTune": "2024-06-14T00:00:00Z", + "inference": "2024-06-14T00:00:00Z", + "deprecationStatus": "Planned" + }, + "lifecycleStatus": "Legacy", + "systemData": { + "createdBy": "Microsoft", + "createdAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedAt": "2021-10-07T00:00:00Z" + }, + "skus": [ + { + "name": "provisioned", + "usageName": "OpenAI.Provisioned.Class1", + "capacity": { + "minimum": 100, + "maximum": 1000, + "step": 100, + "default": 100 + } + } + ] + } + }, + { + "kind": "AIServices", + "skuName": "S0", + "model": { + "format": "OpenAI", + "name": "dall-e-3", + "version": "3.0", + "isDefaultVersion": true, + "skus": [ + { + "name": "Provisioned", + "usageName": "OpenAI.Provisioned.Dalle", + "capacity": { + "minimum": 300, + "maximum": 60000, + "step": 100, + "default": 300 + }, + "deprecationDate": "2025-09-30T00:00:00Z" + } + ], + "maxCapacity": 2, + "capabilities": { + "inference": "true", + "imageGenerations": "true" + }, + "deprecation": { + "inference": "2025-06-30T00:00:00Z", + "deprecationStatus": "Tentative" + }, + "lifecycleStatus": "GenerallyAvailable", + "modelCatalogAssetId": "azureml://registries/azure-openai/models/dall-e-3/versions/3.0", + "systemData": { + "createdBy": "Microsoft", + "createdAt": "2023-08-11T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedAt": "2023-08-11T00:00:00Z" + } + } + }, + { + "kind": "OpenAI", + "skuName": "S0", + "model": { + "format": "OpenAI", + "name": "gpt-35-turbo", + "version": "0301", + "isDefaultVersion": false, + "skus": [ + { + "name": "Standard", + "usageName": "OpenAI.Standard.gpt-35-turbo", + "capacity": { + "maximum": 1000000, + "default": 120 + }, + "deprecationDate": "2025-02-13T00:00:00Z" + }, + { + "name": "Provisioned", + "usageName": "OpenAI.Provisioned.gpt-35-turbo", + "capacity": { + "minimum": 300, + "maximum": 30000, + "step": 100, + "default": 300 + }, + "deprecationDate": "2025-05-15T00:00:00Z" + } + ], + "maxCapacity": 9, + "capabilities": { + "scaleType": "Manual,Standard", + "completion": "true", + "chatCompletion": "true", + "maxTotalToken": "4096" + }, + "deprecation": { + "inference": "2025-04-30T00:00:00Z", + "deprecationStatus": "Planned" + }, + "lifecycleStatus": "Deprecated", + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2023-03-09T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application", + "lastModifiedAt": "2023-07-06T00:00:00Z" + } + } + }, + { + "kind": "OpenAI", + "skuName": "S0", + "model": { + "format": "OpenAI", + "name": "gpt-4o", + "version": "2024-05-13", + "maxCapacity": 50, + "capabilities": { + "fineTune": "false", + "inference": "true", + "scaleType": "Manual,Provisioned", + "completion": "true", + "chat": "true", + "vision": "true" + }, + "deprecation": { + "inference": "2025-09-15T00:00:00Z", + "deprecationStatus": "Tentative" + }, + "replacementConfig": { + "targetModelName": "gpt-4.1", + "targetModelVersion": "2025-04-14", + "autoUpgradeStartDate": "2025-03-26T07:00:00Z", + "upgradeOnExpiryLeadTimeDays": 7 + }, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-05-13", + "lifecycleStatus": "Deprecating", + "systemData": { + "createdBy": "Microsoft", + "createdAt": "2024-05-13T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedAt": "2024-12-15T00:00:00Z" + }, + "skus": [ + { + "name": "provisioned", + "usageName": "OpenAI.Provisioned.GPT4o", + "capacity": { + "minimum": 50, + "maximum": 2000, + "step": 50, + "default": 100 + } + } + ] + } + }, + { + "kind": "AIServices", + "skuName": "S0", + "model": { + "format": "Meta", + "name": "Llama-3.2-90B-Vision-Instruct", + "version": "2", + "isDefaultVersion": false, + "skus": [ + { + "name": "GlobalStandard", + "usageName": "AIServices.GlobalStandard.MaaS", + "capacity": { + "maximum": 1, + "default": 1 + } + } + ], + "maxCapacity": 3, + "capabilities": { + "chatCompletion": "true" + }, + "deprecation": { + "inference": "2099-12-31T00:00:00Z" + }, + "lifecycleStatus": "Stable", + "modelCatalogAssetId": "azureml://registries/azureml-meta/models/Llama-3.2-90B-Vision-Instruct/versions/2", + "systemData": { + "createdBy": "Microsoft", + "createdByType": "Application", + "createdAt": "2024-10-01T00:00:00Z", + "lastModifiedBy": "MaaSModelConverter", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-16T04:45:33.9367873Z" + } + } + }, + { + "kind": "OpenAI", + "skuName": "S0", + "model": { + "format": "OpenAI", + "name": "gpt-4o", + "version": "2024-08-06", + "maxCapacity": 50, + "capabilities": { + "fineTune": "false", + "inference": "true", + "scaleType": "Manual,Standard,Provisioned", + "completion": "true", + "chat": "true", + "vision": "true", + "functionCalling": "true" + }, + "finetuneCapabilities": { + "fineTune": "true", + "inference": "true", + "scaleType": "Manual", + "completion": "true", + "chat": "true" + }, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-08-06", + "lifecycleStatus": "GenerallyAvailable", + "systemData": { + "createdBy": "Microsoft", + "createdAt": "2024-08-06T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedAt": "2024-11-01T00:00:00Z" + }, + "skus": [ + { + "name": "Standard", + "usageName": "OpenAI.Standard.GPT4o", + "capacity": { + "minimum": 1, + "maximum": 100, + "step": 1, + "default": 10 + } + }, + { + "name": "provisioned", + "usageName": "OpenAI.Provisioned.GPT4o", + "capacity": { + "minimum": 50, + "maximum": 2000, + "step": 50, + "default": 100 + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListModelCapacities.json new file mode 100644 index 000000000000..07a13822fb7d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListModelCapacities.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "name": "Standard", + "location": "WestUS", + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "skuName": "Standard", + "availableCapacity": 300, + "availableFinetuneCapacity": 20 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..9f2f48cc1f8a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListPrivateEndpointConnections.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..5642897b3af6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListPrivateLinkResources.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..ae48d3d17a4a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res6977/providers/Microsoft.CognitiveServices/accounts/sto2527/privateLinkResources/account", + "name": "blob", + "type": "Microsoft.CognitiveServices/accounts/privateLinkResources", + "properties": { + "groupId": "account", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.cognitiveservices.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListProjects.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListProjects.json new file mode 100644 index 000000000000..a14730965e30 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListProjects.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject", + "name": "myProject", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "westus", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "provisioningState": "Succeeded", + "displayName": "myProject1", + "description": "This is my project 1", + "endpoints": { + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": true + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject-2", + "name": "myProject-2", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "westus", + "tags": {}, + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "properties": { + "provisioningState": "Succeeded", + "displayName": "myProject2", + "description": "This is my project 2", + "endpoints": { + "OpenAI Language Model Instance API": "https://customSubDomainName2.openai.azure.com/", + "OpenAI Dall-E API": "https://customSubDomainName2.openai.azure.com/" + }, + "isDefault": false + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListQuotaTiers.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListQuotaTiers.json new file mode 100644 index 000000000000..7b7130ccb90a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListQuotaTiers.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-00000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "properties": { + "currentTierName": "Free-Tier", + "assignmentDate": "2025-06-09T18:13:29.389Z", + "tierUpgradePolicy": "OnceUpgradeIsAvailable", + "tierUpgradeEligibilityInfo": { + "nextTierName": "Tier-1", + "upgradeAvailabilityStatus": "Available", + "upgradeApplicableDate": "2025-06-15T18:13:29.389Z" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiContentFilters.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiContentFilters.json new file mode 100644 index 000000000000..bab4cf55353e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiContentFilters.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Hate", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Hate", + "properties": { + "name": "Hate", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Sexual", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Sexual", + "properties": { + "name": "Sexual", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Violence", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Violence", + "properties": { + "name": "Violence", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Selfharm", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Selfharm", + "properties": { + "name": "Selfharm", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Jailbreak", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Jailbreak", + "properties": { + "name": "Jailbreak", + "isMultiLevelFilter": false, + "source": "Prompt" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialText", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "ProtectedMaterialText", + "properties": { + "name": "Protected Material Text", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialCode", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "ProtectedMaterialCode", + "properties": { + "name": "Protected Material Code", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Profanity", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Profanity", + "properties": { + "name": "Profanity", + "isMultiLevelFilter": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiPolicies.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiPolicies.json new file mode 100644 index 000000000000..00af3a772561 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiPolicies.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "Protected Material Text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Protected Material Code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiTopics.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiTopics.json new file mode 100644 index 000000000000..58a8bd9df943 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListRaiTopics.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "topicName": "raiTopicName", + "topicId": "00000000-0000-0000-0000-000000000000", + "description": "This is a sample topic.", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Succeeded", + "failedReason": null, + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlanAssociations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlanAssociations.json new file mode 100644 index 000000000000..192635c92d6a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlanAssociations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/accountAssociationName", + "name": "accountAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlansByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlansByResourceGroup.json new file mode 100644 index 000000000000..1248a3408c02 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlansByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlansBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlansBySubscription.json new file mode 100644 index 000000000000..5cac18f4f2dd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSharedCommitmentPlansBySubscription.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSkus.json new file mode 100644 index 000000000000..bc6085cc9116 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListSkus.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "F0", + "tier": "Free" + } + }, + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListUsages.json new file mode 100644 index 000000000000..aeb82841189f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ListUsages.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "AccountCount", + "localizedValue": "Cognitive Services total account limit" + }, + "currentValue": 3, + "limit": 200, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json new file mode 100644 index 000000000000..e39f846dd79c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "api-version": "2025-10-01-preview", + "body": { + "properties": { + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "category": "UserDefined" + } + }, + "firewallSku": "Standard" + } + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "properties": { + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + }, + "firewallSku": "Standard", + "egressIpAddress": "22.22.131.49" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "properties": { + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + }, + "firewallSku": "Standard", + "egressIpAddress": "22.22.131.49" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/createOrUpdateRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/createOrUpdateRuleV2.json new file mode 100644 index 000000000000..0901aef3ec27 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/createOrUpdateRuleV2.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "ruleName": "rule_name_1", + "managedNetworkName": "default", + "api-version": "2025-10-01-preview", + "body": { + "properties": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "accounts/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "accounts/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/deleteRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/deleteRuleV2.json new file mode 100644 index 000000000000..991dfbc9b9eb --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/deleteRuleV2.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "ruleName": "rule-name", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/getManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/getManagedNetworkV2.json new file mode 100644 index 000000000000..d41cf2bb7e8d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/getManagedNetworkV2.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "properties": { + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + }, + "firewallSku": "Standard", + "egressIpAddress": "22.22.131.49" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/getRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/getRuleV2.json new file mode 100644 index 000000000000..1c00a4671d43 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/getRuleV2.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "ruleName": "name_of_the_fqdn_rule", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "accounts/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_of_the_fqdn_rule", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/listManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/listManagedNetworkV2.json new file mode 100644 index 000000000000..eeccb09a655d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/listManagedNetworkV2.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "properties": { + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + }, + "firewallSku": "Standard", + "egressIpAddress": "22.22.131.49" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/listRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/listRuleV2.json new file mode 100644 index 000000000000..6d9bccbf55fe --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/listRuleV2.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "accounts/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_of_the_fqdn_rule", + "status": "Inactive", + "category": "Required", + "errorInformation": "Error message" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_2", + "name": "rule_name_2", + "type": "accounts/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_of_the_fqdn_rule", + "status": "Inactive", + "category": "Required", + "errorInformation": "Error message" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/patchManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/patchManagedNetworkV2.json new file mode 100644 index 000000000000..59b854ca9e62 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/patchManagedNetworkV2.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "api-version": "2025-10-01-preview", + "body": { + "properties": { + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "category": "UserDefined" + } + }, + "firewallSku": "Standard" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "properties": { + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined", + "errorInformation": null + } + }, + "firewallSku": "Standard", + "egressIpAddress": "22.22.131.49" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/postOutboundRulesV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/postOutboundRulesV2.json new file mode 100644 index 000000000000..cd7ae775d60a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/postOutboundRulesV2.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "managedNetworkName": "default", + "api-version": "2025-10-01-preview", + "body": { + "properties": { + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "destination": "destination_endpoint", + "category": "UserDefined" + } + }, + "firewallSku": "Standard" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "accounts/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_of_the_fqdn_rule", + "status": "Active", + "category": "Required", + "errorInformation": null + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/provisionManagedNetwork.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/provisionManagedNetwork.json new file mode 100644 index 000000000000..60c1bd760715 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ManagedNetwork/provisionManagedNetwork.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "cognitive-account-name", + "api-version": "2025-10-01-preview", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Location": "location_url_to_poll_for_status" + } + }, + "200": { + "body": { + "status": "Active" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/createOrUpdate.json new file mode 100644 index 000000000000..7f3800dc4260 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/createOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "projectName": "project-1", + "capabilityHostName": "capabilityHostName", + "api-version": "2025-10-01-preview", + "capabilityHost": { + "properties": { + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/delete.json new file mode 100644 index 000000000000..99a0c9bac780 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "projectName": "project-1", + "capabilityHostName": "capabilityHostName", + "api-version": "2025-10-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "location_header_to_poll" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/get.json new file mode 100644 index 000000000000..5e8b17893981 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectCapabilityHost/get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "projectName": "project-1", + "capabilityHostName": "capabilityHostName", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/create.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/create.json new file mode 100644 index 000000000000..b7f3dd634b07 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "projectName": "project-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview", + "connection": { + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "None" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "None" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/delete.json new file mode 100644 index 000000000000..213977f256dc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "projectName": "project-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/get.json new file mode 100644 index 000000000000..0508d9ace99b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "projectName": "project-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "None" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/list.json new file mode 100644 index 000000000000..b1fa3151c3d4 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/list.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "accountName": "account-1", + "projectName": "project-1", + "api-version": "2025-10-01-preview", + "target": "[tartget url]", + "category": "ContainerRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/linkedaccounts/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[tartget url]", + "authType": "PAT" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/linkedaccounts/connection-2", + "name": "connection-2", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "properties": { + "category": "ContainerRegistry", + "target": "[tartget url]", + "authType": "PAT" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/update.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/update.json new file mode 100644 index 000000000000..9d38229a633e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ProjectConnection/update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "accountName": "account-1", + "projectName": "project-1", + "connectionName": "connection-1", + "api-version": "2025-10-01-preview", + "connection": { + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PurgeDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PurgeDeletedAccount.json new file mode 100644 index 000000000000..5734dbd7cedd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PurgeDeletedAccount.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "PropTest01", + "location": "westus" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutCommitmentPlan.json new file mode 100644 index 000000000000..e5e0a74385b6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutCommitmentPlan.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutDefenderForAISetting.json new file mode 100644 index 000000000000..15eb4f71e7cd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutDefenderForAISetting.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + }, + "201": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutDeployment.json new file mode 100644 index 000000000000..dab591c255b2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutDeployment.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutEncryptionScope.json new file mode 100644 index 000000000000..ec28e7a07d56 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutEncryptionScope.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName", + "encryptionScope": { + "properties": { + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + }, + "201": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutPrivateEndpointConnection.json new file mode 100644 index 000000000000..65f3bcedcff5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutPrivateEndpointConnection.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "res7687", + "accountName": "sto9699", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2025-10-01-preview", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiBlocklist.json new file mode 100644 index 000000000000..c710534ca8d0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiBlocklist.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklist": { + "properties": { + "description": "Basic blocklist description" + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + }, + "201": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiBlocklistItem.json new file mode 100644 index 000000000000..d9ea7c7a328c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiBlocklistItem.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistItem": { + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + }, + "201": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiPolicy.json new file mode 100644 index 000000000000..ac951f982133 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiPolicy.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiPolicyName": "raiPolicyName", + "raiPolicy": { + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "Protected Material Text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Protected Material Code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "Protected Material Text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Protected Material Code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "Protected Material Text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Protected Material Code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "Profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiTopic.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiTopic.json new file mode 100644 index 000000000000..551a68bb538c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/PutRaiTopic.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiTopicName": "raiTopicName", + "raiTopic": { + "properties": { + "topicName": "raiTopicName", + "description": "This is a sample topic.", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob" + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "topicName": "raiTopicName", + "topicId": "00000000-0000-0000-0000-000000000000", + "description": "This is a sample topic.", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Training", + "failedReason": null, + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z" + } + } + }, + "201": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "topicName": "raiTopicName", + "topicId": "00000000-0000-0000-0000-000000000000", + "description": "This is a sample topic.", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Training", + "failedReason": null, + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ReconcileNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ReconcileNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..2c5c849c1a04 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/ReconcileNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "nspConfigurationName": "NSPConfigurationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/RegenerateKey.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/RegenerateKey.json new file mode 100644 index 000000000000..0a588e0ebd8a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount", + "parameters": { + "keyName": "Key2" + } + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateAccount.json new file mode 100644 index 000000000000..1249b6fdbcc2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateAccount.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "bvttest", + "accountName": "bingSearch", + "account": { + "location": "global", + "sku": { + "name": "S2" + } + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S2" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S2" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateDefenderForAISetting.json new file mode 100644 index 000000000000..4d881c74c768 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateDefenderForAISetting.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateDeployment.json new file mode 100644 index 000000000000..34fd423b96e9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateDeployment.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateProjects.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateProjects.json new file mode 100644 index 000000000000..4d670d305c20 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateProjects.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "bvttest", + "accountName": "bingSearch", + "projectName": "projectName", + "project": { + "location": "global", + "properties": { + "description": "new description." + } + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch/projects/projectName", + "name": "projectName", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "global", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "provisioningState": "Succeeded", + "displayName": "myProject", + "description": "new description.", + "endpoints": { + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch/projects/projectName", + "name": "projectName", + "type": "Microsoft.CognitiveServices/accounts/projects", + "location": "global", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "provisioningState": "Succeeded", + "displayName": "myProject", + "description": "new description.", + "endpoints": { + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateQuotaTier.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateQuotaTier.json new file mode 100644 index 000000000000..be003bd52090 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateQuotaTier.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "default": "default", + "tier": { + "properties": { + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "properties": { + "currentTierName": "Free-Tier", + "assignmentDate": "2025-06-09T18:13:29.389Z", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateSharedCommitmentPlan.json new file mode 100644 index 000000000000..bdf8ffa99215 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/UpdateSharedCommitmentPlan.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2025-10-01-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "tags": { + "name": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + }, + "tags": { + "name": "value" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index 09eab481fa6d..d136e494cdc6 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -30,7 +30,85 @@ These are the global settings for the CognitiveServices API. ```yaml openapi-type: arm -tag: package-2025-09-01 +tag: package-2025-10-01-preview +``` + +### Tag: package-2025-10-01-preview + +These settings apply only when `--tag=package-2025-10-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2025-10-01-preview' +input-file: + - Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json +suppressions: + - code: ProvisioningStateMustBeReadOnly + reason: Provisioning state for agent application definition IS read-only. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}"].get.responses.200.schema + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}"].put.responses.200.schema + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}"].put.responses.201.schema + - code: ArmResourcePropertiesBag + reason: This API is copied from Machine Learning Services RP where this behavior is already established. + where: + - $.definitions.OutboundRuleBasicResource + - code: AvoidAdditionalProperties + reason: This API is copied from Machine Learning Services RP where this behavior is already established. + where: + - $.definitions.ManagedNetworkSettings.properties.outboundRules + - code: ProvisioningStateSpecifiedForLROPut + reason: This API is copied from Machine Learning Services RP where this behavior is already established. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules/{ruleName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}"].put + - code: PutResponseCodes + reason: This API is copied from Machine Learning Services RP where it is already established and in use. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules/{ruleName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}"].put + - code: PutResponseCodes + reason: This is existing behavior in all other APIs and already in stable version, will keep the same. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}"].put + - code: PatchResponseCodes + reason: This is existing behavior in all other APIs and already in stable version, will keep the same. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch + - code: PatchBodyParametersSchema + reason: this is a required field for in a optional property this experience exist in other stable schemas as well. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}"].patch.parameters[5].schema.properties.properties + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch.parameters[3].schema.properties.properties + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch.parameters[3].schema.properties.sku + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}"].patch.parameters[6].schema.properties.properties + - code: GuidUsage + reason: Approved to be suppressed in AML swagger. + where: + - $.definitions.ConnectionOAuth2.properties.clientId.format + - code: DeleteResponseCodes + reason: Behavior is align with other existing API for this RP + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].delete + - code: AvoidAdditionalProperties + reason: Approved to be suppressed in AML swagger + where: + - $.definitions.ConnectionPropertiesV2.properties.metadata + - $.definitions.CustomKeys.properties.keys + - code: NestedResourcesMustHaveListOperation + reason: This API will be added in the later api version, same behavior as AML RP and already got suppression approved. + where: + - $.definitions["CapabilityHostResource"] + - code: LroLocationHeader + reason: Align with existing API behavior in other APIs + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].put.responses.202 + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch.responses.202 + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].delete.responses.202 + - code: AvoidAdditionalProperties + reason: Same as existing account resource, trying to have the same behavior + where: + - $.definitions.ProjectProperties.properties.endpoints ``` ### Tag: package-2025-09-01