你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Accounts - Get

返回由参数指定的认知服务帐户。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2021-10-01

URI 参数

Name In Required Type Description
accountName
path True
  • string

认知服务帐户的名称。

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

资源提供程序应返回 200 (OK) ,以指示操作已成功完成。 有关响应正文中每个字段的详细说明,请参阅 PUT 资源部分中的请求正文说明。 唯一的 GET 特定属性是“name”、“type”和“id”。必填字段说明类型。 字符串。 为此 API 帐户设置的 API。 它可以是 ·单个 API,例如:人脸 API、视觉 API、语音 API。 一组 API:人脸 + 语音、视觉 + 情感等 sku.name 必需。 此 API 的定价层/计划。 可以是:F0 - 免费 B0 - 基本 S0 - 标准 P0 - 高级版

Other Status Codes

描述操作失败原因的错误响应。 如果资源不存在,应返回 404 (NotFound) 。

示例

Get Account

Sample Request

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount?api-version=2021-10-01

Sample Response

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/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"
  }
}

定义

Account

认知服务帐户是一个 Azure 资源,表示预配的帐户、类型、位置和 SKU。

AccountProperties

认知服务帐户的属性。

ApiProperties

特殊 API 的 API 属性。

CallRateLimit

调用速率限制认知服务帐户。

createdByType

创建资源的标识的类型。

Encryption

配置加密的属性

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Identity

资源的标识。

IpRule

一个规则,用于控制特定 IP 地址或 IP 范围的辅助功能。

keySource

枚举 KeySource for Encryption 的可能值

KeyVaultProperties

用于配置 keyVault 属性的属性

NetworkRuleAction

当 ipRules 和 virtualNetworkRules 匹配时没有规则时的默认操作。 仅当评估绕过属性后,才使用此属性。

NetworkRuleSet

一组用于控制网络辅助功能的规则。

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProperties

PrivateEndpointConnectProperties 的属性。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

ProvisioningState

获取调用操作时认知服务帐户的状态。

PublicNetworkAccess

是否允许此帐户访问公共终结点。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”

QuotaLimit
RequestMatchPattern
ResourceIdentityType

标识类型。

Sku

表示 SKU 的资源模型定义

SkuCapability

SkuCapability 指示特定功能的功能。

SkuChangeInfo

Sku 更改帐户信息。

SkuTier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

systemData

与创建和上次修改资源相关的元数据。

ThrottlingRule
UserAssignedIdentity

用户分配的托管标识。

UserOwnedStorage

认知服务帐户的用户拥有存储。

VirtualNetworkRule

管理特定虚拟网络中的辅助功能的规则。

Account

认知服务帐户是一个 Azure 资源,表示预配的帐户、类型、位置和 SKU。

Name Type Description
etag
  • string

资源 Etag。

id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

资源的标识。

kind
  • string

资源的种类。

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties

认知服务帐户的属性。

sku

表示 SKU 的资源模型定义

systemData

与创建和上次修改资源相关的元数据。

tags
  • object

资源标记。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

AccountProperties

认知服务帐户的属性。

Name Type Description
allowedFqdnList
  • string[]
apiProperties

特殊 API 的 API 属性。

callRateLimit

调用速率限制认知服务帐户。

capabilities

获取认知服务帐户的功能。 每个项都指示特定功能的功能。 这些值是只读的,仅供参考。

customSubDomainName
  • string

用于基于令牌的身份验证的可选子域名称。

dateCreated
  • string

获取认知服务帐户创建日期。

disableLocalAuth
  • boolean
encryption

此资源的加密属性。

endpoint
  • string

创建的帐户的终结点。

endpoints
  • object
internalId
  • string

(弃用的内部标识符不使用此属性) 。

isMigrated
  • boolean

如果资源是从现有密钥迁移的。

migrationToken
  • string

资源迁移令牌。

networkAcls

一组规则,用于控制特定网络位置的辅助功能。

privateEndpointConnections

与认知服务帐户关联的专用终结点连接。

provisioningState

获取调用操作时认知服务帐户的状态。

publicNetworkAccess

是否允许对此帐户使用公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”

quotaLimit
restore
  • boolean
restrictOutboundNetworkAccess
  • boolean
skuChangeInfo

Sku 更改帐户信息。

userOwnedStorage

此资源的存储帐户。

ApiProperties

特殊 API 的 API 属性。

Name Type Description
aadClientId
  • string

(指标顾问仅) Azure AD 客户端 ID (应用程序 ID) 。

aadTenantId
  • string

(指标顾问仅) Azure AD 租户 ID。

eventHubConnectionString
  • string

(个性化仅) 启用必应搜索统计信息的标志。

qnaAzureSearchEndpointId
  • string

(QnAMaker 仅) QnAMaker 的 Azure 搜索终结点 ID。

qnaAzureSearchEndpointKey
  • string

(QnAMaker 仅) QnAMaker 的 Azure 搜索终结点密钥。

qnaRuntimeEndpoint
  • string

(QnAMaker 仅) QnAMaker 的运行时终结点。

statisticsEnabled
  • boolean

(必应搜索仅) 启用必应搜索统计信息的标志。

storageAccountConnectionString
  • string

(个性化仅) 存储帐户连接字符串。

superUser
  • string

(指标顾问仅) 指标顾问超级用户。

websiteName
  • string

(指标顾问仅) 指标顾问的网站名称。

CallRateLimit

调用速率限制认知服务帐户。

Name Type Description
count
  • number

呼叫速率限制的计数值。

renewalPeriod
  • number

呼叫速率限制的续订周期(以秒为单位)。

rules

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Encryption

配置加密的属性

Name Type Default Value Description
keySource Microsoft.KeyVault

枚举 KeySource for Encryption 的可能值

keyVaultProperties

KeyVault 的属性

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

Identity

资源的标识。

Name Type Description
principalId
  • string

资源标识的主体 ID。

tenantId
  • string

资源的租户 ID。

type

标识类型。

userAssignedIdentities

与资源关联的用户分配标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

一个规则,用于控制特定 IP 地址或 IP 范围的辅助功能。

Name Type Description
value
  • string

CIDR 表示法中的 IPv4 地址范围,例如“124.56.78.91” (简单 IP 地址) 或“124.56.78.0/24” (以 124.56.78) 开头的所有地址。

keySource

枚举 KeySource for Encryption 的可能值

Name Type Description
Microsoft.CognitiveServices
  • string
Microsoft.KeyVault
  • string

KeyVaultProperties

用于配置 keyVault 属性的属性

Name Type Description
identityClientId
  • string
keyName
  • string

KeyVault 中密钥的名称

keyVaultUri
  • string

KeyVault 的 URI

keyVersion
  • string

KeyVault 中的密钥版本

NetworkRuleAction

当 ipRules 和 virtualNetworkRules 匹配时没有规则时的默认操作。 仅当评估绕过属性后,才使用此属性。

Name Type Description
Allow
  • string
Deny
  • string

NetworkRuleSet

一组用于控制网络辅助功能的规则。

Name Type Description
defaultAction

当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时,默认操作。 仅在评估绕过属性后,才使用此属性。

ipRules

IP 地址规则的列表。

virtualNetworkRules

虚拟网络规则的列表。

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
etag
  • string

资源 Etag。

id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

专用终结点连接的位置

name
  • string

资源的名称

properties

资源属性。

systemData

与创建和上次修改资源相关的元数据。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

PrivateEndpointConnectionProperties

PrivateEndpointConnectProperties 的属性。

Name Type Description
groupIds
  • string[]

专用链接资源组 ID。

privateEndpoint

专用终结点的资源。

privateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

provisioningState

专用终结点连接资源的预配状态。

PrivateEndpointConnectionProvisioningState

当前预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

Name Type Description
actionsRequired
  • string

一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。

description
  • string

批准/拒绝连接的原因。

status

指示连接是否已由服务的所有者批准/拒绝/删除。

ProvisioningState

获取调用操作时认知服务帐户的状态。

Name Type Description
Accepted
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Moving
  • string
ResolvingDNS
  • string
Succeeded
  • string

PublicNetworkAccess

是否允许此帐户访问公共终结点。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”

Name Type Description
Disabled
  • string
Enabled
  • string

QuotaLimit

Name Type Description
count
  • number
renewalPeriod
  • number
rules

RequestMatchPattern

Name Type Description
method
  • string
path
  • string

ResourceIdentityType

标识类型。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

Sku

表示 SKU 的资源模型定义

Name Type Description
capacity
  • integer

如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略。

family
  • string

如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。

name
  • string

SKU 的名称。 前 - P3。 它通常是字母+数字代码

size
  • string

SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。

tier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

SkuCapability

SkuCapability 指示特定功能的功能。

Name Type Description
name
  • string

SkuCapability 的名称。

value
  • string

SkuCapability 的值。

SkuChangeInfo

Sku 更改帐户信息。

Name Type Description
countOfDowngrades
  • number

获取降级计数。

countOfUpgradesAfterDowngrades
  • number

获取降级后的升级计数。

lastChangeDate
  • string

获取上次更改日期。

SkuTier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

Name Type Description
Basic
  • string
Enterprise
  • string
Free
  • string
Premium
  • string
Standard
  • string

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。

ThrottlingRule

Name Type Description
count
  • number
dynamicThrottlingEnabled
  • boolean
key
  • string
matchPatterns
minCount
  • number
renewalPeriod
  • number

UserAssignedIdentity

用户分配的托管标识。

Name Type Description
clientId
  • string

与此标识关联的客户端应用 ID。

principalId
  • string

Azure Active Directory与此标识关联的主体 ID。

UserOwnedStorage

认知服务帐户的用户拥有存储。

Name Type Description
identityClientId
  • string
resourceId
  • string

Microsoft 的完整资源 ID。存储资源。

VirtualNetworkRule

管理特定虚拟网络中的辅助功能的规则。

Name Type Description
id
  • string

vnet 子网的完整资源 ID,例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。

ignoreMissingVnetServiceEndpoint
  • boolean

忽略缺少的 vnet 服务终结点。

state
  • string

获取虚拟网络规则的状态。