Skip to main content

accounts_models

Creates, updates, deletes, gets or lists an accounts_models resource.

Overview

Nameaccounts_models
TypeResource
Idazure.cognitive_services.accounts_models

Fields

The following fields are returned by SELECT queries:

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 Description
sku Required, object
The exact set of keys that define this sku. This matches the fields on the respective resource.
sku.name Required, string
The name of the SKU. This is typically a letter + number code, such as A0 or P3
sku.tier Required, string
The tier of this particular SKU. Typically one of:
· Free
· Basic
· Standard
· Premium

NameDatatypeDescription
namestringDeployment model name.
baseModelobjectProperties of Cognitive Services account deployment model.
callRateLimitobjectThe call rate limit Cognitive Services account.
capabilitiesobjectThe capabilities.
deprecationobjectCognitive Services account ModelDeprecationInfo.
finetuneCapabilitiesobjectThe capabilities for finetune models.
formatstringDeployment model format.
isDefaultVersionbooleanIf the model is default version.
lifecycleStatusstringModel lifecycle status.
maxCapacityinteger (int32)The max capacity.
skusarrayThe list of Model Sku.
sourcestringOptional. Deployment model source ARM resource ID.
systemDataobjectMetadata pertaining to creation and last modification of the resource.
versionstringOptional. 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.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectresourceGroupName, accountName, subscriptionIdList available Models for the requested Cognitive Services account

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
accountNamestringThe name of Cognitive Services account.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
subscriptionIdstringThe ID of the target subscription.

SELECT examples

List available Models for the requested Cognitive Services account

SELECT
name,
baseModel,
callRateLimit,
capabilities,
deprecation,
finetuneCapabilities,
format,
isDefaultVersion,
lifecycleStatus,
maxCapacity,
skus,
source,
systemData,
version
FROM azure.cognitive_services.accounts_models
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;