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

User Group - List

服务:

API Management

API 版本:

2024-05-01

列出所有用户组。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups?api-version=2024-05-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=2024-05-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
userId	path	True	string minLength: 1 maxLength: 80	用户标识符。 当前 API 管理服务实例中必须是唯一的。
api-version	query	True	string minLength: 1	用于此操作的 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 | |description |filter |ge， le， eq， ne， gt， lt |substringof， contains， startswith， endswith |
$skip	query		integer (int32) minimum: 0	要跳过的记录数。
$top	query		integer (int32) minimum: 1	要返回的记录数。

响应

名称	类型	说明
200 OK	GroupCollection	列出组实体的集合。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementListUserGroups

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/groups?api-version=2024-05-01

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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": ""
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GroupCollection	分页组列表表示形式。
GroupContract	合同详细信息。
GroupType	组类型。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

GroupCollection

Object

分页组列表表示形式。

名称	类型	说明
count	integer (int64)	所有页面的总记录计数数。
nextLink	string	下一页链接（如果有）。
value	GroupContract[]	页面值。

GroupContract

Object

合同详细信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.builtIn	boolean	如果组是三个系统组之一（管理员、开发人员或来宾），则为 true;否则为 false。
properties.description	string maxLength: 1000	组说明。 可以包含 HTML 格式标记。
properties.displayName	string minLength: 1 maxLength: 300	组名称。
properties.externalId	string	对于外部组，此属性包含来自外部标识提供者的组的 ID，例如，对于 Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>;否则，该值为 null。
properties.type	GroupType	组类型。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

GroupType

枚举

组类型。

值	说明
custom
external
system