Accounts - Get
返回由参数指定的认知服务帐户。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2024-10-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
account
|
path | True |
string minLength: 2maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ |
认知服务帐户的名称。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 名称不区分大小写。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
资源提供程序应返回 200 (正常)以指示作已成功完成。 有关响应正文中每个字段的详细说明,请参阅 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
示例请求
示例响应
{
"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"
}
}
定义
| 名称 | 说明 |
|---|---|
|
Abuse |
滥用惩罚。 |
|
Abuse |
AbusePenalty 的行动。 |
| Account |
认知服务帐户是一个 Azure 资源,表示预配的帐户、类型、位置和 SKU。 |
|
Account |
认知服务帐户的属性。 |
|
Api |
特殊 API 的 API 属性。 |
|
By |
为受信任的服务设置。 |
|
Call |
调用速率限制认知服务帐户。 |
|
Commitment |
承诺计划关联。 |
|
created |
创建资源的标识的类型。 |
| Encryption |
用于配置加密的属性 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
| Identity |
资源的标识。 |
|
Ip |
一个规则,用于控制特定 IP 地址或 ip 范围的辅助功能。 |
|
key |
枚举 KeySource for Encryption 的可能值 |
|
Key |
用于配置 keyVault 属性的属性 |
|
Multi |
多区域设置认知服务帐户。 |
|
Network |
当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时,默认作。 仅当评估绕过属性后,才使用此属性。 |
|
Network |
一组控制网络可访问性的规则。 |
|
Private |
专用终结点资源。 |
|
Private |
专用终结点连接资源。 |
|
Private |
PrivateEndpointConnectProperties 的属性。 |
|
Private |
当前预配状态。 |
|
Private |
专用终结点连接状态。 |
|
Private |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
Provisioning |
获取调用作时认知服务帐户的状态。 |
|
Public |
是否允许对此帐户使用公共终结点访问。 |
|
Quota |
|
|
Rai |
认知服务 Rai Monitor 配置。 |
|
Region |
调用速率限制认知服务帐户。 |
|
Request |
|
|
Resource |
标识类型。 |
|
Routing |
多区域路由方法。 |
| Sku |
表示 SKU 的资源模型定义 |
|
Sku |
SkuCapability 指示特定功能的功能。 |
|
Sku |
帐户的 SKU 更改信息。 |
|
Sku |
如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。 |
|
system |
与创建和上次修改资源相关的元数据。 |
|
Throttling |
|
|
User |
用户分配的托管标识。 |
|
User |
用户拥有认知服务帐户的 AML 工作区。 |
|
User |
认知服务帐户的用户拥有存储。 |
|
Virtual |
一个规则,用于控制来自特定虚拟网络的辅助功能。 |
AbusePenalty
滥用惩罚。
| 名称 | 类型 | 说明 |
|---|---|---|
| action |
AbusePenalty 的行动。 |
|
| expiration |
string (date-time) |
AbusePenalty 到期日期时间。 |
| rateLimitPercentage |
number |
速率限制的百分比。 |
AbusePenaltyAction
AbusePenalty 的行动。
| 值 | 说明 |
|---|---|
| Throttle | |
| Block |
Account
认知服务帐户是一个 Azure 资源,表示预配的帐户、类型、位置和 SKU。
| 名称 | 类型 | 说明 |
|---|---|---|
| etag |
string |
资源 Etag。 |
| id |
string |
资源的完全限定资源 ID。 示例 - /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.Storage/storageAccounts” |
AccountProperties
认知服务帐户的属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| abusePenalty |
滥用惩罚。 |
|
| allowedFqdnList |
string[] |
|
| amlWorkspace |
用户拥有 AML 工作区属性。 |
|
| apiProperties |
特殊 API 的 API 属性。 |
|
| callRateLimit |
调用速率限制认知服务帐户。 |
|
| capabilities |
获取认知服务帐户的功能。 每个项都指示特定功能的功能。 这些值是只读的,仅供参考。 |
|
| commitmentPlanAssociations |
认知服务帐户的承诺计划关联。 |
|
| customSubDomainName |
string |
用于基于令牌的身份验证的可选子域名称。 |
| dateCreated |
string |
获取认知服务帐户创建日期。 |
| deletionDate |
string |
删除日期,仅适用于已删除的帐户。 |
| disableLocalAuth |
boolean |
|
| dynamicThrottlingEnabled |
boolean |
用于启用动态限制的标志。 |
| encryption |
此资源的加密属性。 |
|
| endpoint |
string |
已创建的帐户的终结点。 |
| endpoints |
object |
|
| internalId |
string |
内部标识符(已弃用,不使用此属性)。 |
| isMigrated |
boolean |
如果资源是从现有密钥迁移的。 |
| locations |
认知服务帐户的多区域设置。 |
|
| migrationToken |
string |
资源迁移令牌。 |
| networkAcls |
一组规则,用于控制特定网络位置的可访问性。 |
|
| privateEndpointConnections |
与认知服务帐户关联的专用终结点连接。 |
|
| provisioningState |
获取调用作时认知服务帐户的状态。 |
|
| publicNetworkAccess |
是否允许对此帐户使用公共终结点访问。 |
|
| quotaLimit | ||
| raiMonitorConfig |
认知服务 Rai Monitor 配置。 |
|
| restore |
boolean |
|
| restrictOutboundNetworkAccess |
boolean |
|
| scheduledPurgeDate |
string |
计划的清除日期,仅适用于已删除的帐户。 |
| skuChangeInfo |
帐户的 SKU 更改信息。 |
|
| userOwnedStorage |
此资源的存储帐户。 |
ApiProperties
特殊 API 的 API 属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| aadClientId |
string maxLength: 500 |
(仅限指标顾问)Azure AD 客户端 ID(应用程序 ID)。 |
| aadTenantId |
string maxLength: 500 |
(仅限指标顾问)Azure AD 租户 ID。 |
| eventHubConnectionString |
string maxLength: 1000pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$ |
(仅限个性化)启用必应搜索统计信息的标志。 |
| qnaAzureSearchEndpointId |
string |
(仅限 QnAMaker)QnAMaker 的 Azure 搜索终结点 ID。 |
| qnaAzureSearchEndpointKey |
string |
(仅限 QnAMaker)QnAMaker 的 Azure 搜索终结点密钥。 |
| qnaRuntimeEndpoint |
string |
(仅限 QnAMaker)QnAMaker 的运行时终结点。 |
| statisticsEnabled |
boolean |
(仅必应搜索)启用必应搜索统计信息的标志。 |
| storageAccountConnectionString |
string maxLength: 1000pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$ |
(仅限个性化)存储帐户连接字符串。 |
| superUser |
string maxLength: 500 |
(仅限指标顾问)指标顾问的超级用户。 |
| websiteName |
string maxLength: 500 |
(仅限指标顾问)指标顾问的网站名称。 |
ByPassSelection
为受信任的服务设置。
| 值 | 说明 |
|---|---|
| None | |
| AzureServices |
CallRateLimit
调用速率限制认知服务帐户。
| 名称 | 类型 | 说明 |
|---|---|---|
| count |
number |
呼叫速率限制的计数值。 |
| renewalPeriod |
number |
呼叫速率限制的续订期(以秒为单位)。 |
| rules |
CommitmentPlanAssociation
承诺计划关联。
| 名称 | 类型 | 说明 |
|---|---|---|
| commitmentPlanId |
string |
承诺计划的 Azure 资源 ID。 |
| commitmentPlanLocation |
string |
承诺计划的位置。 |
createdByType
创建资源的标识的类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
Encryption
用于配置加密的属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| keySource | Microsoft.KeyVault |
枚举 KeySource for Encryption 的可能值 |
|
| keyVaultProperties |
KeyVault 的属性 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
Identity
资源的标识。
| 名称 | 类型 | 说明 |
|---|---|---|
| principalId |
string |
资源标识的主体 ID。 |
| tenantId |
string |
资源的租户 ID。 |
| type |
标识类型。 |
|
| userAssignedIdentities |
<string,
User |
与资源关联的用户分配标识的列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
IpRule
一个规则,用于控制特定 IP 地址或 ip 范围的辅助功能。
| 名称 | 类型 | 说明 |
|---|---|---|
| value |
string |
CIDR 表示法中的 IPv4 地址范围,例如“124.56.78.91”(简单 IP 地址)或“124.56.78.0/24”(以 124.56.78 开头的所有地址)。 |
keySource
枚举 KeySource for Encryption 的可能值
| 值 | 说明 |
|---|---|
| Microsoft.CognitiveServices | |
| Microsoft.KeyVault |
KeyVaultProperties
用于配置 keyVault 属性的属性
| 名称 | 类型 | 说明 |
|---|---|---|
| identityClientId |
string |
|
| keyName |
string |
KeyVault 中密钥的名称 |
| keyVaultUri |
string |
KeyVault 的 URI |
| keyVersion |
string |
KeyVault 中密钥的版本 |
MultiRegionSettings
多区域设置认知服务帐户。
| 名称 | 类型 | 说明 |
|---|---|---|
| regions |
调用速率限制认知服务帐户。 |
|
| routingMethod |
多区域路由方法。 |
NetworkRuleAction
当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时,默认作。 仅当评估绕过属性后,才使用此属性。
| 值 | 说明 |
|---|---|
| Allow | |
| Deny |
NetworkRuleSet
一组控制网络可访问性的规则。
| 名称 | 类型 | 说明 |
|---|---|---|
| bypass |
为受信任的服务设置。 |
|
| defaultAction |
当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时,默认作。 仅当评估绕过属性后,才使用此属性。 |
|
| ipRules |
Ip |
IP 地址规则的列表。 |
| virtualNetworkRules |
虚拟网络规则的列表。 |
PrivateEndpoint
专用终结点资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
专用终结点的 ARM 标识符 |
PrivateEndpointConnection
专用终结点连接资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| etag |
string |
资源 Etag。 |
| id |
string |
资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
专用终结点连接的位置 |
| name |
string |
资源的名称 |
| properties |
资源属性。 |
|
| systemData |
与创建和上次修改资源相关的元数据。 |
|
| type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProperties
PrivateEndpointConnectProperties 的属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| groupIds |
string[] |
专用链接资源组 ID。 |
| privateEndpoint |
专用终结点的资源。 |
|
| privateLinkServiceConnectionState |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
| provisioningState |
专用终结点连接资源的预配状态。 |
PrivateEndpointConnectionProvisioningState
当前预配状态。
| 值 | 说明 |
|---|---|
| Succeeded | |
| Creating | |
| Deleting | |
| Failed |
PrivateEndpointServiceConnectionStatus
专用终结点连接状态。
| 值 | 说明 |
|---|---|
| Pending | |
| Approved | |
| Rejected |
PrivateLinkServiceConnectionState
有关服务使用者与提供程序之间的连接状态的信息集合。
| 名称 | 类型 | 说明 |
|---|---|---|
| actionsRequired |
string |
一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。 |
| description |
string |
批准/拒绝连接的原因。 |
| status |
指示连接是否已被服务的所有者批准/拒绝/删除。 |
ProvisioningState
获取调用作时认知服务帐户的状态。
| 值 | 说明 |
|---|---|
| Accepted | |
| Creating | |
| Deleting | |
| Moving | |
| Failed | |
| Succeeded | |
| ResolvingDNS |
PublicNetworkAccess
是否允许对此帐户使用公共终结点访问。
| 值 | 说明 |
|---|---|
| Enabled | |
| Disabled |
QuotaLimit
| 名称 | 类型 | 说明 |
|---|---|---|
| count |
number |
|
| renewalPeriod |
number |
|
| rules |
RaiMonitorConfig
认知服务 Rai Monitor 配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| adxStorageResourceId |
string |
存储资源 ID。 |
| identityClientId |
string |
用于访问存储的标识客户端 ID。 |
RegionSetting
调用速率限制认知服务帐户。
| 名称 | 类型 | 说明 |
|---|---|---|
| customsubdomain |
string |
将区域映射到区域自定义子域。 |
| name |
string |
区域的名称。 |
| value |
number |
优先级或加权路由方法的值。 |
RequestMatchPattern
| 名称 | 类型 | 说明 |
|---|---|---|
| method |
string |
|
| path |
string |
ResourceIdentityType
标识类型。
| 值 | 说明 |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned, UserAssigned |
RoutingMethods
多区域路由方法。
| 值 | 说明 |
|---|---|
| Priority | |
| Weighted | |
| Performance |
Sku
表示 SKU 的资源模型定义
| 名称 | 类型 | 说明 |
|---|---|---|
| capacity |
integer (int32) |
如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略此范围。 |
| family |
string |
如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。 |
| name |
string |
SKU 的名称。 例 - P3。 它通常是字母+数字代码 |
| size |
string |
SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。 |
| tier |
如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。 |
SkuCapability
SkuCapability 指示特定功能的功能。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
SkuCapability 的名称。 |
| value |
string |
SkuCapability 的值。 |
SkuChangeInfo
帐户的 SKU 更改信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| countOfDowngrades |
number |
获取降级计数。 |
| countOfUpgradesAfterDowngrades |
number |
获取降级后的升级计数。 |
| lastChangeDate |
string |
获取上次更改日期。 |
SkuTier
如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。
| 值 | 说明 |
|---|---|
| Free | |
| Basic | |
| Standard | |
| Premium | |
| Enterprise |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |
ThrottlingRule
| 名称 | 类型 | 说明 |
|---|---|---|
| count |
number |
|
| dynamicThrottlingEnabled |
boolean |
|
| key |
string |
|
| matchPatterns | ||
| minCount |
number |
|
| renewalPeriod |
number |
UserAssignedIdentity
用户分配的托管标识。
| 名称 | 类型 | 说明 |
|---|---|---|
| clientId |
string |
与此标识关联的客户端应用 ID。 |
| principalId |
string |
与此标识关联的 Azure Active Directory 主体 ID。 |
UserOwnedAmlWorkspace
用户拥有认知服务帐户的 AML 工作区。
| 名称 | 类型 | 说明 |
|---|---|---|
| identityClientId |
string |
AML 工作区资源的标识客户端 ID。 |
| resourceId |
string |
AML 工作区资源的完整资源 ID。 |
UserOwnedStorage
认知服务帐户的用户拥有存储。
| 名称 | 类型 | 说明 |
|---|---|---|
| identityClientId |
string |
|
| resourceId |
string |
Microsoft.Storage 资源的完整资源 ID。 |
VirtualNetworkRule
一个规则,用于控制来自特定虚拟网络的辅助功能。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
vnet 子网的完整资源 ID,例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。 |
| ignoreMissingVnetServiceEndpoint |
boolean |
忽略缺少的 vnet 服务终结点。 |
| state |
string |
获取虚拟网络规则的状态。 |