通过

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

Group - List By Service

  • 参考
服务:
API Management
API 版本:
2022-08-01

列出服务实例中定义的组的集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups?api-version=2022-08-01
具有可选参数: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI 参数

名称 在 必需 类型 说明
resourceGroupName
 path True

string

资源组的名称。 此名称不区分大小写。
serviceName
 path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

目标订阅的 ID。
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 |
|description |filter |ge、le、eq、ne、gt、lt |substringof， contains， startswith， endswith |
|externalId |filter |eq | |
$skip
 query

integer

int32

要跳过的记录数。
$top
 query

integer

int32

要返回的记录数。

响应

名称 类型 说明
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 模拟用户帐户

示例

ApiManagementListGroups

示例请求

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

示例响应

状态代码:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020001",
      "type": "Microsoft.ApiManagement/service/groups",
      "name": "5600b59375ff190048020001",
      "properties": {
        "displayName": "Administrators",
        "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.",
        "builtIn": true,
        "type": "system"
      }
    },
    {
      "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"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020002",
      "type": "Microsoft.ApiManagement/service/groups",
      "name": "5600b59375ff190048020002",
      "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"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020003",
      "type": "Microsoft.ApiManagement/service/groups",
      "name": "5600b59375ff190048020003",
      "properties": {
        "displayName": "Guests",
        "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.",
        "builtIn": true,
        "type": "system"
      }
    }
  ],
  "count": 4,
  "nextLink": ""
}

定义

名称 说明
ErrorFieldContract

错误字段协定。
ErrorResponse

错误响应。
GroupCollection

分页的组列表表示形式。
GroupContract

合同详细信息。
GroupType

组类型。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。
message

string

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

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

ErrorFieldContract[]

在发生验证错误的情况下，在请求中发送的无效字段列表。
error.message

string

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

GroupCollection

分页的组列表表示形式。

名称 类型 说明
count

integer

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

string

下一页链接（如果有）。
value

GroupContract[]

页面值。

GroupContract

合同详细信息。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

资源的名称
properties.builtIn

boolean

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

string

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

string

组名称。
properties.externalId

string

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

GroupType

组类型。
type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

GroupType

组类型。

名称 类型 说明
custom

string

external

string

system

string