Workspace Group User - List

Szolgáltatás:

API Management

API-verzió:

2024-05-01

A csoporthoz társított felhasználói entitások gyűjteményét sorolja fel.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
groupId	path	True	string minLength: 1 maxLength: 256	Csoportazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.
$filter	query		string	| Mező | Használat | Támogatott operátorok | Támogatott függvények | |-------------|-------------|-------------|-------------| | név | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | e-mail | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | registrationDate | szűrő | ge, le, eq, ne, gt, lt | | | megjegyzés | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip	query		integer (int32) minimum: 0	Kihagyandó rekordok száma.
$top	query		integer (int32) minimum: 1	A visszaadni kívánt rekordok száma.

Válaszok

Name	Típus	Description
200 OK	UserCollection	A csoporthoz társított felhasználói entitások gyűjteményét sorolja fel.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ApiManagementListWorkspaceGroupUsers

Mintakérelem

HTTP

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

Java

/**
 * Samples for WorkspaceGroupUser List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListWorkspaceGroupUsers.json
     */
    /**
     * Sample code: ApiManagementListWorkspaceGroupUsers.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListWorkspaceGroupUsers(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.workspaceGroupUsers().list("rg1", "apimService1", "wks1", "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_workspace_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.workspace_group_user.list(
        resource_group_name="rg1",
        service_name="apimService1",
        workspace_id="wks1",
        group_id="57d2ef278aa04f0888cba3f3",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListWorkspaceGroupUsers.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/ApiManagementListWorkspaceGroupUsers.json
func ExampleWorkspaceGroupUserClient_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.NewWorkspaceGroupUserClient().NewListPager("rg1", "apimService1", "wks1", "57d2ef278aa04f0888cba3f3", &armapimanagement.WorkspaceGroupUserClientListOptions{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/workspaces/groups/users"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/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/ApiManagementListWorkspaceGroupUsers.json
 */
async function apiManagementListWorkspaceGroupUsers() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const workspaceId = "wks1";
  const groupId = "57d2ef278aa04f0888cba3f3";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.workspaceGroupUser.list(
    resourceGroupName,
    serviceName,
    workspaceId,
    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/ApiManagementListWorkspaceGroupUsers.json
// this example is just showing the usage of "WorkspaceGroupUser_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 ServiceWorkspaceGroupResource created on azure
// for more information of creating ServiceWorkspaceGroupResource, please refer to the document of ServiceWorkspaceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string workspaceId = "wks1";
string groupId = "57d2ef278aa04f0888cba3f3";
ResourceIdentifier serviceWorkspaceGroupResourceId = ServiceWorkspaceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, workspaceId, groupId);
ServiceWorkspaceGroupResource serviceWorkspaceGroup = client.GetServiceWorkspaceGroupResource(serviceWorkspaceGroupResourceId);

// invoke the operation and iterate over the result
await foreach (ApiManagementUserResource item in serviceWorkspaceGroup.GetWorkspaceGroupUsersAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    UserContractData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/kjoshiarmTemplateUser1",
      "type": "Microsoft.ApiManagement/service/workspaces/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": ""
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GroupContractProperties	Csoportszerződés tulajdonságai.
GroupType	Csoport típusa.
UserCollection	Lapozott felhasználók listaábrázolása.
UserContract	Felhasználói adatok.
UserIdentityContract	Felhasználói identitás részletei.
UserState	Fiók állapota. Megadja, hogy a felhasználó aktív-e vagy sem. A letiltott felhasználók nem tudnak bejelentkezni a fejlesztői portálra, és nem hívhatják meg az előfizetett termékek API-jait. Az alapértelmezett állapot aktív.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GroupContractProperties

Objektum

Csoportszerződés tulajdonságai.

Name	Típus	Description
builtIn	boolean	igaz, ha a csoport a három rendszercsoport egyike (rendszergazdák, fejlesztők vagy vendégek); egyéb esetben hamis.
description	string maxLength: 1000	Csoport leírása. HTML-formázási címkéket tartalmazhat.
displayName	string minLength: 1 maxLength: 300	Csoport neve.
externalId	string	Külső csoportok esetén ez a tulajdonság a külső identitásszolgáltatótól származó csoport azonosítóját tartalmazza, például az Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; ellenkező esetben az érték null.
type	GroupType	Csoport típusa.

GroupType

Enumerálás

Csoport típusa.

Érték	Description
custom
external
system

UserCollection

Objektum

Lapozott felhasználók listaábrázolása.

Name	Típus	Description
count	integer (int64)	Összes rekordszám az összes oldalon.
nextLink	string	Ha van ilyen, a következő oldal hivatkozása.
value	UserContract[]	Oldalértékek.

UserContract

Objektum

Felhasználói adatok.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Az erőforrás neve
properties.email	string		E-mail-cím.
properties.firstName	string		Keresztnév.
properties.groups	GroupContractProperties[]		A csoportok felhasználójának gyűjteménye a része.
properties.identities	UserIdentityContract[]		Felhasználói identitások gyűjteménye.
properties.lastName	string		Vezetéknév.
properties.note	string		Nem kötelező megjegyzés a rendszergazda által beállított felhasználóról.
properties.registrationDate	string (date-time)		A felhasználói regisztráció dátuma. A dátum a következő formátumnak felel meg: yyyy-MM-ddTHH:mm:ssZ az ISO 8601 szabványnak megfelelően.
properties.state	UserState	active	Fiók állapota. Megadja, hogy a felhasználó aktív-e vagy sem. A letiltott felhasználók nem tudnak bejelentkezni a fejlesztői portálra, és nem hívhatják meg az előfizetett termékek API-jait. Az alapértelmezett állapot aktív.
type	string		Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

UserIdentityContract

Objektum

Felhasználói identitás részletei.

Name	Típus	Description
id	string	Azonosító értéke a szolgáltatón belül.
provider	string	Identitásszolgáltató neve.

UserState

Enumerálás

Fiók állapota. Megadja, hogy a felhasználó aktív-e vagy sem. A letiltott felhasználók nem tudnak bejelentkezni a fejlesztői portálra, és nem hívhatják meg az előfizetett termékek API-jait. Az alapértelmezett állapot aktív.

Érték	Description
active	A felhasználói állapot aktív.
blocked	A felhasználó le van tiltva. A letiltott felhasználók nem tudnak hitelesítést végezni a fejlesztői portálon, és nem hívhatják meg az API-t.
deleted	A felhasználói fiók bezárult. A rendszer eltávolítja az összes identitást és kapcsolódó entitást.
pending	A felhasználói fiók függőben van. Ahhoz, hogy aktívvá lehessen tenni, identitás-megerősítést igényel.