Skip to content

Refactory CognitiveServicesAccount model specification. #7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anuchandy merged 2 commits into from Oct 21, 2019
Merged

Refactory CognitiveServicesAccount model specification. #7415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90ee9c9
Refactory CognitiveServicesAccount model specification.
yangyuan Oct 4, 2019
7a341e3
fix samples
yangyuan Oct 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 42 additions & 78 deletions ...ces/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@
"description": "The name of Cognitive Services account."
},
{
"name": "parameters",
"name": "account",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CognitiveServicesAccountCreateParameters"
"$ref": "#/definitions/CognitiveServicesAccount"
},
"description": "The parameters to provide for the created account."
},
Expand Down Expand Up @@ -124,12 +124,11 @@
"description": "The name of Cognitive Services account."
},
{
"name": "parameters",
"name": "account",
"in": "body",
"required": true,
"x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/CognitiveServicesAccountUpdateParameters"
"$ref": "#/definitions/CognitiveServicesAccount"
},
"description": "The parameters to provide for the created account."
},
Expand Down Expand Up @@ -638,7 +637,7 @@
"tags": [
"CognitiveServicesAccounts"
],
"operationId": "CheckSkuAvailability_List",
"operationId": "CheckSkuAvailability",
"description": "Check available SKUs.",
"x-ms-examples": {
"Check SKU Availability": {
Expand Down Expand Up @@ -718,64 +717,10 @@
}
},
"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."
},
"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."
},
"properties": {
"type": "object",
"description": "Additional properties for Account. Only provided fields will be updated."
}
},
"description": "The parameters to provide for the account."
},
"Sku": {
"properties": {
"name": {
Expand Down Expand Up @@ -812,16 +757,17 @@
"properties": {
"etag": {
"type": "string",
"description": "Entity Tag"
"description": "Entity Tag",
"readOnly": true
},
"id": {
"type": "string",
"description": "The id of the created account",
"readOnly": true
},
"kind": {
"type": "string",
"description": "Type of cognitive service account."
"$ref": "#/definitions/CognitiveServicesAccountKind",
"description": "The Kind of the resource."
},
"location": {
"type": "string",
Expand All @@ -833,7 +779,6 @@
"readOnly": true
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/CognitiveServicesAccountProperties",
"description": "Properties of Cognitive Services account."
},
Expand Down Expand Up @@ -894,11 +839,13 @@
},
"endpoint": {
"type": "string",
"description": "Endpoint of the created account."
"description": "Endpoint of the created account.",
"readOnly": true
},
"internalId": {
"type": "string",
"description": "The internal identifier."
"description": "The internal identifier.",
"readOnly": true
},
"customSubDomainName": {
"type": "string",
Expand All @@ -907,10 +854,39 @@
"networkAcls": {
"$ref": "#/definitions/NetworkRuleSet",
"description": "A collection of rules governing the accessibility from specific network locations."
},
"apiProperties": {
"$ref": "#/definitions/CognitiveServicesAccountApiProperties",
"description": "The api properties for special APIs."
}
},
"description": "Properties of Cognitive Services account."
},
"CognitiveServicesAccountApiProperties": {
"properties": {
"qnaRuntimeEndpoint": {
"type": "string",
"description": "(QnAMaker Only) The runtime endpoint 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
}
},
"description": "The api properties for special APIs."
},
"CognitiveServicesAccountKeys": {
"properties": {
"key1": {
Expand Down Expand Up @@ -1383,18 +1359,6 @@
},
"NetworkRuleSet": {
"properties": {
"bypass": {
"type": "string",
"description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.",
"enum": [
"AzureServices",
"None"
],
"x-ms-enum": {
"name": "NetworkRuleBypassOptions",
"modelAsString": true
}
},
"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.",
Expand Down
2 changes: 1 addition & 1 deletion ...esource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CreateAccount.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3",
"resourceGroupName": "felixwa-01",
"accountName": "testCreate1",
"parameters": {
"account": {
"location": "West US",
"kind": "Emotion",
"sku": {
Expand Down
2 changes: 1 addition & 1 deletion ...esource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/UpdateAccount.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3",
"resourceGroupName": "bvttest",
"accountName": "bingSearch",
"parameters": {
"account": {
"sku": {
"name": "S2"
}
Expand Down