您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Accounts - List

返回属于订阅的特定类型的所有资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts?api-version=2021-04-30

URI 参数

Name In Required Type Description
subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

用于此操作的 API 版本。

响应

Name Type Description
200 OK

资源提供程序应返回 200 (正常) 指示操作已成功完成。 对于其他 (例如内部错误) 使用相应的 HTTP 错误代码。 nextLink 字段应指向客户端用于提取下一页的 URL, (服务器端分页) 。 这符合分页响应的 OData 准则。 如果资源提供程序不支持分页,则它应返回相同的正文,但将 nextLink 留空,供将来兼容。 有关响应正文中每个字段的详细说明,请参阅 PUT 资源部分中的请求正文说明。

Other Status Codes

描述操作失败原因的错误响应

示例

List Accounts by Subscription

Sample Request

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.CognitiveServices/accounts?api-version=2021-04-30

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
      "name": "bingSearch",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "global",
      "sku": {
        "name": "S1"
      },
      "kind": "Bing.Search",
      "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"",
      "properties": {
        "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd",
      "name": "CrisProd",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "CRIS",
      "tags": {
        "can't delete it successfully": "v-yunjin"
      },
      "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308",
      "name": "rayrptest0308",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "Face",
      "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02",
      "name": "raytest02",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "Emotion",
      "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

定义

Account

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

AccountListResult

认知服务帐户操作响应的列表。

AccountProperties

认知服务帐户的属性。

ApiProperties

特殊 API 的 API 属性。

CallRateLimit

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

createdByType

创建资源的标识类型。

Encryption

用于配置加密的属性

ErrorAdditionalInfo

资源管理错误其他信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Identity

资源的标识。

IpRule

一个规则,用于管理特定 IP 地址或 IP 范围的可访问性。

keySource

枚举用于加密的 keySource 的可能值

KeyVaultProperties

用于配置 keyVault 属性的属性

NetworkRuleAction

当 ipRules 和 virtualNetworkRules 中的规则不匹配时的默认操作。 这仅在计算 bypass 属性后使用。

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。 例如 - /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"

AccountListResult

认知服务帐户操作响应的列表。

Name Type Description
nextLink
  • string

用于获取下一页帐户的链接。

value

获取认知服务帐户及其属性的列表。

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 Description
keySource

枚举用于加密的 keySource 的可能值

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 的可能值

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 中的规则不匹配时的默认操作。 这仅在计算 bypass 属性后使用。

Name Type Description
Allow
  • string
Deny
  • string

NetworkRuleSet

一组规则,用于管理网络可访问性。

Name Type Description
defaultAction

当 ipRules 和 virtualNetworkRules 中的规则不匹配时的默认操作。 这仅在计算 bypass 属性后使用。

ipRules

IP 地址规则的列表。

virtualNetworkRules

虚拟网络规则的列表。

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
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 的属性。

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.Storage 资源的完整资源 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

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