{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-cognitiveservices","description":"CognitiveServicesManagementClient","version":"2017-04-18","base_url":"https://management.azure.com","endpoints":19,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api CognitiveServicesManagementClient\n@base https://management.azure.com\n@version 2017-04-18\n@auth OAuth2\n@endpoints 19\n@toc subscriptions(18), providers(1)\n\n@group subscriptions\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}\n@desc 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.\n@required {accountName: any # The name of Cognitive Services account., account: map # The parameters to provide for the created account.}\n@returns(200) If resource is created successfully or already existed, the service should return 200 (OK).\n@returns(201) If resource is created successfully, the service should return 201 (OK).\n@returns(202) HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}\n@desc Updates a Cognitive Services account\n@required {accountName: any # The name of Cognitive Services account., account: map # The parameters to provide for the created account.}\n@returns(200) The resource provider should return 200 (OK) to indicate that the operation completed successfully.\n@returns(202) HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}\n@desc Deletes a Cognitive Services account from the resource group.\n@required {accountName: any # The name of Cognitive Services account.}\n@returns(200) A 200 (OK) should be returned if the object exists and was deleted successfully;\n@returns(202) HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.\n@returns(204) a 204 (NoContent) should be used if the resource does not exist and the request is well formed.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}\n@desc Returns a Cognitive Services account specified by the parameters.\n@required {accountName: any # The name of Cognitive Services account.}\n@returns(200) The resource provider should return 200 (OK) to indicate that the operation completed successfully. For 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.\" Field\tDescription Kind\trequired.  String. \tThe API set for this API account. It can be  \t· a single API, for example: Face API, Vision API, Speech API.  \ta bundle of APIs:  Face + Speech, Vision + Emotion, etc. sku.name\tRequired. \tThe pricing tier/plan of this API. Could be:  \tF0 - Free \tB0 - Basic \tS0 - Standard \tP0 - Premium\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts\n@desc Returns all the resources of a particular type belonging to a resource group\n@returns(200) 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. The 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. The nextLink should be implemented using following query parameters: · 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. · top: the optional client query parameter which defines the maximum number of records to be returned by the server. Implementation details: · NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query.  · Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response.  Clients 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.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts\n@desc Returns all the resources of a particular type belonging to a subscription.\n@returns(200) 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. The 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. For a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys\n@desc Lists the account keys for the specified Cognitive Services account.\n@required {accountName: any # The name of Cognitive Services account.}\n@returns(200) Returns with a response body containing the subscription keys for the resource: key1 The first API key for authentication when client calls the API endpoint.  key2 The second API key for authentication when client calls the API endpoint.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey\n@desc Regenerates the specified account key for the specified Cognitive Services account.\n@required {accountName: any # The name of Cognitive Services account., parameters: any # regenerate key parameters.}\n@returns(200)\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/skus\n@desc Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/skus\n@desc List available SKUs for the requested Cognitive Services account\n@required {accountName: any # The name of Cognitive Services account.}\n@returns(200) The resource provider should return 200 (OK) to indicate that the operation completed successfully. For 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.\" Field\tDescription sku\tRequired, object \tThe exact set of keys that define this sku. This matches the fields on the respective resource. sku.name\tRequired, string \tThe name of the SKU. This is typically a letter + number code, such as A0 or P3 sku.tier\tRequired, string \tThe tier of this particular SKU. Typically one of: \t· Free \t· Basic \t· Standard \t· Premium\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages\n@desc Get usages for the requested Cognitive Services account\n@required {accountName: any # The name of Cognitive Services account.}\n@optional {$filter: any # 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).}\n@returns(200) The usages for Cognitive Services account were retrieved successfully.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.CognitiveServices/operations\n@desc Lists all the available Cognitive Services account operations.\n@returns(200) OK.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability\n@desc Check available SKUs.\n@required {location: any # Resource location., parameters: any # Check SKU Availability POST body.}\n@returns(200) OK.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability\n@desc Check whether a domain is available.\n@required {parameters: any # Check Domain Availability parameter.}\n@returns(200) OK.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections\n@desc Gets the private endpoint connections associated with the Cognitive Services account.\n@required {accountName: any # The name of Cognitive Services account.}\n@returns(200) Successfully retrieved private endpoint connections.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}\n@desc Gets the specified private endpoint connection associated with the Cognitive Services account.\n@required {accountName: any # The name of Cognitive Services account., privateEndpointConnectionName: any # The name of the private endpoint connection associated with the Cognitive Services Account}\n@returns(200) OK -- Get the private endpoint connection properties successfully.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}\n@desc Update the state of specified private endpoint connection associated with the Cognitive Services account.\n@required {accountName: any # The name of Cognitive Services account., privateEndpointConnectionName: any # The name of the private endpoint connection associated with the Cognitive Services Account, properties: any # The private endpoint connection properties.}\n@returns(200) OK -- Update the private endpoint connection properties successfully.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}\n@desc Deletes the specified private endpoint connection associated with the Cognitive Services account.\n@required {accountName: any # The name of Cognitive Services account., privateEndpointConnectionName: any # The name of the private endpoint connection associated with the Cognitive Services Account}\n@returns(200) OK -- Delete the private endpoint connection successfully.\n@returns(204) No Content -- The private endpoint connection does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateLinkResources\n@desc Gets the private link resources that need to be created for a Cognitive Services account.\n@required {accountName: any # The name of Cognitive Services account.}\n@returns(200) Successfully retrieved private link resources.\n\n@endgroup\n\n@end\n"}