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

Group - Get

获取由其标识符指定的组的详细信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2020-12-01

URI 参数

Name In Required Type Description
groupId
path True
  • string

组标识符。 在当前API 管理服务实例中必须是唯一的。

resourceGroupName
path True
  • string

资源组的名称。

serviceName
path True
  • string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

要用于客户端请求的 API 的版本。

响应

Name Type Description
200 OK

响应正文包含指定的组实体。

Headers

  • ETag: string
Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ApiManagementGetGroup

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9?api-version=2020-12-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "59306a29e4bbd510dc24e5f9",
  "properties": {
    "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)",
    "description": "awesome group of people",
    "builtIn": false,
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca"
  }
}

定义

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

GroupContract

合同详细信息。

GroupType

组类型。

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

属性级错误的人类可读表示形式。

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

错误的用户可读表示形式。

GroupContract

合同详细信息。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.builtIn
  • boolean

如果组是管理员、开发人员或来宾 (三个系统组之一,则为 true) ;否则为 false。

properties.description
  • string

组说明。 可以包含采用 HTML 格式的标记。

properties.displayName
  • string

组名称。

properties.externalId
  • string

对于外部组,此属性包含来自外部标识提供者的组的 ID,例如对于Azure Active Directoryaad://<tenant>.onmicrosoft.com/groups/<group object id>;否则值为 null。

properties.type

组类型。

type
  • string

API 管理资源的资源类型。

GroupType

组类型。

Name Type Description
custom
  • string
external
  • string
system
  • string