Group - Get

Service:

API Management

API Version:

2021-08-01

Mendapatkan detail grup yang ditentukan oleh pengidentifikasinya.

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

Parameter URI

Name	In	Required	Type	Description
groupId	path	True	string	Pengidentifikasi grup. Harus unik dalam instans layanan API Management saat ini.
resourceGroupName	path	True	string	Nama grup sumber daya.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien.

Respons

Name	Type	Description
200 OK	GroupContract	Isi respons berisi entitas Grup yang ditentukan. Headers ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementGetGroup

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for Group Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetGroup.json
     */
    /**
     * Sample code: ApiManagementGetGroup.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetGroup(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.groups().getWithResponse("rg1", "apimService1", "59306a29e4bbd510dc24e5f9", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetGroup.json
func ExampleGroupClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armapimanagement.NewGroupClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"apimService1",
		"59306a29e4bbd510dc24e5f9",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "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"
  }
}

Definisi

ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
GroupContract	Detail kontrak.
GroupType	Jenis grup.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name	Type	Description
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Name	Type	Description
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

GroupContract

Detail kontrak.

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.builtIn	boolean	true jika grup adalah salah satu dari tiga grup sistem (Administrator, Pengembang, atau Tamu); jika tidak salah.
properties.description	string	Deskripsi grup. Dapat berisi tag pemformatan HTML.
properties.displayName	string	Nama grup.
properties.externalId	string	Untuk grup eksternal, properti ini berisi id grup dari penyedia identitas eksternal, misalnya untuk Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; jika tidak, nilainya null.
properties.type	GroupType	Jenis grup.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

GroupType

Jenis grup.

Name	Type	Description
custom	string
external	string
system	string