Group User - List

服务:

API Management

API 版本:

2024-05-01

列出与组关联的用户实体的集合。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
groupId	path	True	string minLength: 1 maxLength: 256	组标识符。 当前 API 管理服务实例中必须是唯一的。
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。
api-version	query	True	string minLength: 1	用于此作的 API 版本。
$filter	query		string	|字段 |用法 |支持的运算符 |支持的函数 | |-------------|-------------|-------------|-------------| |name |filter |ge， le， eq， ne， gt， lt |substringof， contains， startswith， endswith | |firstName |filter |ge， le， eq， ne， gt， lt |substringof， contains， startswith， endswith | |lastName |filter |ge， le， eq， ne， gt， lt |substringof， contains， startswith， endswith | |电子邮件 |filter |ge， le， eq， ne， gt， lt |substringof， contains， startswith， endswith | |registrationDate |filter |ge， le， eq， ne， gt， lt | | |注意 |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	UserCollection	列出与组关联的用户实体的集合。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementListGroupUsers

示例请求

HTTP

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

Java

/**
 * Samples for GroupUser List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListGroupUsers.json
     */
    /**
     * Sample code: ApiManagementListGroupUsers.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListGroupUsers(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.groupUsers().list("rg1", "apimService1", "57d2ef278aa04f0888cba3f3", null, null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_group_users.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.group_user.list(
        resource_group_name="rg1",
        service_name="apimService1",
        group_id="57d2ef278aa04f0888cba3f3",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListGroupUsers.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListGroupUsers.json
func ExampleGroupUserClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGroupUserClient().NewListPager("rg1", "apimService1", "57d2ef278aa04f0888cba3f3", &armapimanagement.GroupUserClientListOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.UserCollection = armapimanagement.UserCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.UserContract{
		// 		{
		// 			Name: to.Ptr("armTemplateUser1"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/groups/users"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1"),
		// 			Properties: &armapimanagement.UserContractProperties{
		// 				Identities: []*armapimanagement.UserIdentityContract{
		// 					{
		// 						ID: to.Ptr("user1@live.com"),
		// 						Provider: to.Ptr("Basic"),
		// 				}},
		// 				Note: to.Ptr("note for user 1"),
		// 				State: to.Ptr(armapimanagement.UserStateActive),
		// 				Email: to.Ptr("user1@live.com"),
		// 				FirstName: to.Ptr("user1"),
		// 				LastName: to.Ptr("lastname1"),
		// 				RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-31T18:54:41.447Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists a collection of user entities associated with the group.
 *
 * @summary Lists a collection of user entities associated with the group.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListGroupUsers.json
 */
async function apiManagementListGroupUsers() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const groupId = "57d2ef278aa04f0888cba3f3";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.groupUser.list(resourceGroupName, serviceName, groupId)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListGroupUsers.json
// this example is just showing the usage of "GroupUser_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementGroupResource created on azure
// for more information of creating ApiManagementGroupResource, please refer to the document of ApiManagementGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string groupId = "57d2ef278aa04f0888cba3f3";
ResourceIdentifier apiManagementGroupResourceId = ApiManagementGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, groupId);
ApiManagementGroupResource apiManagementGroup = client.GetApiManagementGroupResource(apiManagementGroupResourceId);

// invoke the operation and iterate over the result
await foreach (ApiManagementGroupUserData item in apiManagementGroup.GetGroupUsersAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1",
      "type": "Microsoft.ApiManagement/service/groups/users",
      "name": "armTemplateUser1",
      "properties": {
        "firstName": "user1",
        "lastName": "lastname1",
        "email": "user1@live.com",
        "state": "active",
        "registrationDate": "2017-05-31T18:54:41.447Z",
        "note": "note for user 1",
        "identities": [
          {
            "provider": "Basic",
            "id": "user1@live.com"
          }
        ]
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GroupContractProperties	组协定属性。
GroupType	组类型。
UserCollection	分页用户列表表示形式。
UserContract	用户详细信息。
UserIdentityContract	用户标识详细信息。
UserState	帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录到开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

GroupContractProperties

Object

组协定属性。

名称	类型	说明
builtIn	boolean	如果组是三个系统组之一（管理员、开发人员或来宾），则为 true;否则为 false。
description	string maxLength: 1000	组说明。 可以包含 HTML 格式标记。
displayName	string minLength: 1 maxLength: 300	组名称。
externalId	string	对于外部组，此属性包含来自外部标识提供者的组的 ID，例如，对于 Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>;否则，该值为 null。
type	GroupType	组类型。

GroupType

枚举

组类型。

值	说明
custom
external
system

UserCollection

Object

分页用户列表表示形式。

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

UserContract

Object

用户详细信息。

名称	类型	默认值	说明
id	string		资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		资源的名称
properties.email	string		电子邮件地址。
properties.firstName	string		名字。
properties.groups	GroupContractProperties[]		组用户的集合是其中的一部分。
properties.identities	UserIdentityContract[]		用户标识的集合。
properties.lastName	string		姓。
properties.note	string		有关管理员设置的用户的可选说明。
properties.registrationDate	string (date-time)		用户注册日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
properties.state	UserState	active	帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录到开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。
type	string		资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

UserIdentityContract

Object

用户标识详细信息。

名称	类型	说明
id	string	提供程序中的标识符值。
provider	string	标识提供者名称。

UserState

枚举

帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录到开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。

值	说明
active	用户状态处于活动状态。
blocked	用户被阻止。 被阻止的用户无法在开发人员门户或调用 API 进行身份验证。
deleted	用户帐户已关闭。 删除所有标识和相关实体。
pending	用户帐户处于挂起状态。 要求确认身份，然后才能使其处于活动状态。