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

User Group - List

列出所有用户组。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups?api-version=2020-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2020-12-01

URI 参数

Name In Required Type Description
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 的一部分。

userId
path True
  • string

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

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。

$filter
query
  • string

|字段|使用情况|支持的运算符|支持的函数|
|-------------|------------------------|-----------------------------------|
|name |filter |ge, le, eq, ne, gt, lt |substringof、contains、startswith、endswith |
|displayName |filter |ge, le, eq, ne, gt, lt |substringof、contains、startswith、endswith |
|说明|filter |ge, le, eq, ne, gt, lt |substringof、contains、startswith、endswith |

$skip
query
  • integer
int32

要跳过的记录数。

$top
query
  • integer
int32

要返回的记录数。

响应

Name Type Description
200 OK

列出组实体的集合。

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 模拟用户帐户

示例

ApiManagementListUserGroups

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/groups/5600b57e7e8880006a020002",
      "type": "Microsoft.ApiManagement/service/users/groups",
      "name": "5600b57e7e8880006a020002",
      "properties": {
        "displayName": "Developers",
        "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.",
        "builtIn": true,
        "type": "system"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定义

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

GroupCollection

分页组列表表示形式。

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

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

GroupCollection

分页组列表表示形式。

Name Type Description
count
  • integer

所有页面的总记录计数数。

nextLink
  • string

下一页链接(如果有)。

value

页面值。

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