diff --git a/arm-cognitiveservices/2017-04-18/examples/CheckSkuAvailability.json b/arm-cognitiveservices/2017-04-18/examples/CheckSkuAvailability.json new file mode 100644 index 000000000000..c23d3006652d --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/CheckSkuAvailability.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "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/arm-cognitiveservices/2017-04-18/examples/CreateAccount.json b/arm-cognitiveservices/2017-04-18/examples/CreateAccount.json new file mode 100644 index 000000000000..4021e4482df5 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/CreateAccount.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "felixwa-01", + "accountName": "testCreate1", + "parameters": { + "location": "West US", + "kind": "Emotion", + "sku": { + "name": "S0" + }, + "properties": { + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/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", + "internalId": "9dc1c5b9bb95486aa63899acdaebd9a0" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/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", + "internalId": "9dc1c5b9bb95486aa63899acdaebd9a0" + } + } + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/examples/DeleteAccount.json b/arm-cognitiveservices/2017-04-18/examples/DeleteAccount.json new file mode 100644 index 000000000000..aefd55fd1b86 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/DeleteAccount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "felixwa-01", + "accountName": "PropTest01" + }, + "responses": { + "200": { + }, + "204": { + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/examples/GetAccount.json b/arm-cognitiveservices/2017-04-18/examples/GetAccount.json new file mode 100644 index 000000000000..e104abe338a0 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/GetAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "felixwa-01", + "accountName": "felixwatest1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/providers/Microsoft.CognitiveServices/accounts/felixwatest1", + "name": "felixwatest1", + "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", + "internalId": "a6bb5ff85a3b4c6eb8de8798567a78c6" + } + } + } + } +} \ No newline at end of file diff --git a/arm-cognitiveservices/2017-04-18/examples/GetOperations.json b/arm-cognitiveservices/2017-04-18/examples/GetOperations.json new file mode 100644 index 000000000000..89ed157330b1 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/GetOperations.json @@ -0,0 +1,312 @@ +{ + "parameters": { + "api-version": "2017-04-18" + }, + "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" + }, + { + "name": "Microsoft.CognitiveServices/accounts/listKeys/action", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "List Keys", + "description": "List Keys" + }, + "origin": "user" + }, + { + "name": "Microsoft.CognitiveServices/accounts/regenerateKey/action", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Regenerate Key", + "description": "Regenerate Key" + }, + "origin": "user" + }, + { + "name": "Microsoft.CognitiveServices/accounts/usages/read", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Get the quota usage for an existing resource", + "description": "Get the quota usage for an existing resource." + }, + "origin": "user" + }, + { + "name": "Microsoft.CognitiveServices/accounts/skus/read", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Read available SKUs for an existing resource", + "description": "Reads available SKUs for an existing resource." + }, + "origin": "user" + }, + { + "name": "Microsoft.CognitiveServices/accounts/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "TotalCalls", + "displayName": "Total Calls", + "displayDescription": "Total number of calls.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "SuccessfulCalls", + "displayName": "Successful Calls", + "displayDescription": "Number of successful calls.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "TotalErrors", + "displayName": "Total Errors", + "displayDescription": "Total number of calls with error response (HTTP response code 4xx or 5xx).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "BlockedCalls", + "displayName": "Blocked Calls", + "displayDescription": "Number of calls that exceeded rate or quota limit.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "ServerErrors", + "displayName": "Server Errors", + "displayDescription": "Number of calls with service internal error (HTTP response code 5xx).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "ClientErrors", + "displayName": "Client Errors", + "displayDescription": "Number of calls with client side error (HTTP response code 4xx).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "DataIn", + "displayName": "Data In", + "displayDescription": "Size of incoming data in bytes.", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "DataOut", + "displayName": "Data Out", + "displayDescription": "Size of outgoing data in bytes.", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "Latency", + "displayName": "Latency", + "displayDescription": "Latency in milliseconds.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + }, + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + } + ] + } + }, + "name": "Microsoft.CognitiveServices/accounts/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "The metric definition of Cognitive Services", + "operation": "Read Cognitive Services metric definitions", + "description": "Gets the available metrics for Cognitive Services." + }, + "origin": "system" + }, + { + "name": "Microsoft.CognitiveServices/Operations/read", + "display": { + "provider": "Resource Provider display name.", + "resource": "Resource type display name.", + "operation": "Operation display name.", + "description": "Description of the operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/checkSkuAvailabilityaction", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Reads avaible SKUs for an subscription.", + "description": "Reads avaible SKUs for an subscription." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/updateAccountsCreationSettingswrite", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Allow to create CognitiveServices account for an given subscription/ApiKind/location.", + "description": "Allow to create CognitiveServices account for an given subscription/ApiKind/location." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accountsCreationSettingsread", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Get settings for given subscription/ApiKind/location.", + "description": "Get settings for given subscription/ApiKind/location." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/examples/ListAccountsByResourceGroup.json b/arm-cognitiveservices/2017-04-18/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..d6f656c9ef28 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "felixwa-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/providers/Microsoft.CognitiveServices/accounts/felixwatest1", + "name": "felixwatest1", + "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", + "internalId": "a6bb5ff85a3b4c6eb8de8798567a78c6" + } + }, + { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/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", + "internalId": "0d40510f999141509dbfd9e1f9b259ca" + } + } + ] + } + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/examples/ListAccountsBySubscription.json b/arm-cognitiveservices/2017-04-18/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..56d3877c167c --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/ListAccountsBySubscription.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/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", + "internalId": "ceebe1e8e40f44e69554c1a759de4cf9" + } + }, + { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/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", + "internalId": "cb9a1ad4861a46ef8e440268f763d09e" + } + }, + { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/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", + "internalId": "c83b58e58b6f4049a6d0d1328473326c" + } + }, + { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/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", + "internalId": "c118e8b8f4534cff991f2b7c216342df" + } + } + ] + } + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/examples/ListAccountsCreationSettings.json b/arm-cognitiveservices/2017-04-18/examples/ListAccountsCreationSettings.json new file mode 100644 index 000000000000..b58f2e672de0 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/ListAccountsCreationSettings.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "location": "global" + }, + "responses": { + "200": { + "value": [ + { + "kind": "Bing.Search", + "allowCreate": true, + "lastUpdatedDateTime": "2017-04-10T09:14:50.8037601Z" + } + ] + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/examples/ListKeys.json b/arm-cognitiveservices/2017-04-18/examples/ListKeys.json new file mode 100644 index 000000000000..616ebacc32ca --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/ListKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "felixwa-01", + "accountName": "felixwatest1" + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} \ No newline at end of file diff --git a/arm-cognitiveservices/2017-04-18/examples/ListSkus.json b/arm-cognitiveservices/2017-04-18/examples/ListSkus.json new file mode 100644 index 000000000000..35e59f91b070 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/ListSkus.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "felixwa-01", + "accountName": "felixwatest1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "F0", + "tier": "Free" + } + }, + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/arm-cognitiveservices/2017-04-18/examples/RegenerateKey.json b/arm-cognitiveservices/2017-04-18/examples/RegenerateKey.json new file mode 100644 index 000000000000..5cccadea181a --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "felixwa-01", + "accountName": "felixwatest1", + "parameters": { + "keyName": "Key2" + } + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} \ No newline at end of file diff --git a/arm-cognitiveservices/2017-04-18/examples/UpdateAccount.json b/arm-cognitiveservices/2017-04-18/examples/UpdateAccount.json new file mode 100644 index 000000000000..85ccd6e423c5 --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/UpdateAccount.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "resourceGroupName": "bvttest", + "accountName": "bingSearch", + "parameters": { + "sku": { + "name": "S2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/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", + "internalId": "ceebe1e8e40f44e69554c1a759de4cf9" + } + } + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/examples/UpdateAccountsCreationSettings.json b/arm-cognitiveservices/2017-04-18/examples/UpdateAccountsCreationSettings.json new file mode 100644 index 000000000000..922a57ac14da --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/examples/UpdateAccountsCreationSettings.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2017-04-18", + "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", + "location": "westeurope", + "parameters": { + "settings": [ + { + "kind": "Face", + "allowCreate": true + } + ] + } + }, + "responses": { + "200": { + } + } +} diff --git a/arm-cognitiveservices/2017-04-18/swagger/cognitiveservices.json b/arm-cognitiveservices/2017-04-18/swagger/cognitiveservices.json new file mode 100644 index 000000000000..0dff921f042e --- /dev/null +++ b/arm-cognitiveservices/2017-04-18/swagger/cognitiveservices.json @@ -0,0 +1,1134 @@ +{ + "swagger": "2.0", + "info": { + "title": "CognitiveServicesManagementClient", + "description": "Cognitive Services Management Client", + "version": "2017-04-18" + }, + "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": "CognitiveServicesAccounts_Create", + "x-ms-examples": { + "Get Account": { + "$ref": "../examples/CreateAccount.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "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." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CognitiveServicesAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/CognitiveServicesAccount" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/CognitiveServicesAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Updates a Cognitive Services account", + "operationId": "CognitiveServicesAccounts_Update", + "x-ms-examples": { + "Get Account": { + "$ref": "../examples/UpdateAccount.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "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." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CognitiveServicesAccountUpdateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/CognitiveServicesAccount" + } + }, + "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": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group. ", + "operationId": "CognitiveServicesAccounts_Delete", + "x-ms-examples": { + "Delete Account": { + "$ref": "../examples/DeleteAccount.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "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." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "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": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "operationId": "CognitiveServicesAccounts_GetProperties", + "x-ms-examples": { + "Get Account": { + "$ref": "../examples/GetAccount.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "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." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/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/CognitiveServicesAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/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": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/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/CognitiveServicesAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "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": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/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/CognitiveServicesAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CognitiveServicesAccounts_ListKeys", + "description": "Lists the account keys for the specified Cognitive Services account.", + "x-ms-examples": { + "List Keys": { + "$ref": "../examples/ListKeys.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "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." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/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/CognitiveServicesAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CognitiveServicesAccounts_RegenerateKey", + "description": "Regenerates the specified account key for the specified Cognitive Services account.", + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "../examples/RegenerateKey.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "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." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + }, + "description": "regenerate key parameters." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CognitiveServicesAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/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": "CognitiveServicesAccounts_ListSkus", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "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." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/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/CognitiveServicesAccountEnumerateSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/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": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability": { + "post": { + "tags": [ "CognitiveServicesAccounts" ], + "operationId": "CheckSkuAvailability_List", + "description": "Check available SKUs.", + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "../examples/CheckSkuAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CheckSkuAvailabilityParameter" + }, + "description": "Check SKU Availablity POST body." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CheckSkuAvailabilityResultList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/updateAccountsCreationSettings": { + "post": { + "tags": [ "CognitiveServicesAccounts" ], + "operationId": "CognitiveServices_UpdateAccountsCreationSettings", + "description": "Update accounts creation settings.", + "x-ms-examples": { + "Update Account Creation Settings": { + "$ref": "../examples/UpdateAccountsCreationSettings.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CognitiveServicesAccountsCreationSettingUpdateParameter" + }, + "description": "Update Cognitive Services accounts creation settings." + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/listAccountsCreationSettings": { + "post": { + "tags": [ "CognitiveServicesAccounts" ], + "operationId": "CognitiveServices_ListAccountsCreationSettings", + "description": "List Cognitive Services accounts creation settings.", + "x-ms-examples": { + "Update Account Creation Settings": { + "$ref": "../examples/ListAccountsCreationSettings.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CognitiveServicesAccountsCreationSettingResult" + } + } + } + } + } + }, + "definitions": { + "CognitiveServicesAccountCreateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Required. Gets or sets the SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/CognitiveServicesAccountKind", + "description": "Required. Gets or sets the Kind of the resource." + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "properties": { + "type": "object", + "description": "Must exist in the request. Must be an empty object. Must not be null." + } + }, + "required": [ + "sku", + "kind", + "location", + "properties" + ], + "description": "The parameters to provide for the account." + }, + "CognitiveServicesAccountKind": { + "type": "string", + "description": "Required. Indicates the type of cognitive service account.", + "enum": [ + "Academic", + "Bing.Autosuggest", + "Bing.Search", + "Bing.Speech", + "Bing.SpellCheck", + "ComputerVision", + "ContentModerator", + "CustomSpeech", + "Emotion", + "Face", + "LUIS", + "Recommendations", + "SpeakerRecognition", + "Speech", + "SpeechTranslation", + "TextAnalytics", + "TextTranslation", + "WebLM" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "CognitiveServicesAccountUpdateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + } + }, + "description": "The parameters to provide for the account." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the sku name. Required for account creation, optional for update.", + "enum": [ + "F0", + "P0", + "P1", + "P2", + "S0", + "S1", + "S2", + "S3", + "S4", + "S5", + "S6" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name.", + "enum": [ + "Free", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + } + }, + "required": [ + "name" + ], + "description": "The SKU of the cognitive services account." + }, + "CognitiveServicesAccount": { + "description": "Cognitive Services Account is an Azure resource representing the provisioned account, its type, location and SKU.", + "type": "object", + "properties": { + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "id": { + "type": "string", + "description": "The id of the created account" + }, + "kind": { + "type": "string", + "description": "Type of cognitive service account." + }, + "location": { + "type": "string", + "description": "The location of the resource" + }, + "name": { + "type": "string", + "description": "The name of the created account" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CognitiveServicesAccountProperties", + "description": "Properties of Cognitive Services account." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of Cognitive Services account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "type": { + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + }, + "CognitiveServicesAccountListResult": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of accounts.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CognitiveServicesAccount" + }, + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CognitiveServicesAccountProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the cognitive services account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "endpoint": { + "type": "string", + "description": "Endpoint of the created account." + }, + "internalId": { + "type": "string", + "description": "The internal identifier." + } + }, + "description": "Properties of Cognitive Services account." + }, + "CognitiveServicesAccountKeys": { + "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." + }, + "RegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "key name to generate (Key1|Key2)", + "enum": [ + "Key1", + "Key2" + ], + "x-ms-enum": { + "name": "KeyName", + "modelAsString": false + } + } + }, + "description": "Regenerate key parameters." + }, + "CognitiveServicesAccountEnumerateSkusResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CognitiveServicesResourceAndSku" + }, + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CognitiveServicesResourceAndSku": { + "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." + }, + "Error": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorBody", + "description": "The error body." + } + }, + "description": "Cognitive Services error object." + }, + "ErrorBody": { + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "description": "Cognitive Services error body.", + "required": [ + "code", + "message" + ] + }, + "OperationEntityListResult": { + "description": "The list of cognitive services accounts operation response.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + } + } + }, + "OperationEntity": { + "description": "The operation supported by Cognitive Services.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Cognitive Services." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + }, + "properties": { + "description": "Additional properties.", + "type": "object" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Cognitive Services.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft Cognitive Services.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "CheckSkuAvailabilityParameter": { + "description": "Check SKU availability parameter.", + "properties": { + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "description": "The SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/CognitiveServicesAccountKind", + "description": "The Kind of the resource." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + } + } + }, + "CheckSkuAvailabilityResultList": { + "description": "Check SKU availability result list.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CheckSkuAvailabilityResult" + }, + "description": "Check SKU availability result list." + } + } + }, + "CheckSkuAvailabilityResult": { + "description": "Check SKU availability result.", + "properties": { + "kind": { + "$ref": "#/definitions/CognitiveServicesAccountKind", + "description": "The Kind of the resource." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "skuName": { + "$ref": "#/definitions/Sku", + "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." + } + } + }, + "CognitiveServicesAccountsCreationSetting": { + "description": "Accounts creation setting entity.", + "properties": { + "kind": { + "$ref": "#/definitions/CognitiveServicesAccountKind", + "description": "Kind of Cognitive Services account." + }, + "allowCreate": { + "type": "boolean", + "description": "Whether allow user to create resource." + } + } + }, + "CognitiveServicesAccountsCreationSettingUpdateParameter": { + "description": "Accounts creation setting update parameter.", + "properties": { + "settings": { + "type": "array", + "items": { + "$ref": "#/definitions/CognitiveServicesAccountsCreationSetting" + }, + "description": "Account creation settings." + } + } + }, + "CognitiveServicesAccountsCreationSettingResult": { + "description": "Accounts creation setting result list.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CognitiveServicesAccountsCreationSetting" + }, + "description": "Account creation setting result list." + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2017-04-18" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "Resource location.", + "required": true, + "type": "string" + } + } +} \ No newline at end of file