Group - Get
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=2022-08-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
group
|
path | True |
string |
Pengidentifikasi grup. Harus unik dalam instans layanan API Management saat ini. |
resource
|
path | True |
string |
Nama grup sumber daya. Nama tidak peka huruf besar/kecil. |
service
|
path | True |
string |
Nama layanan API Management. Pola regex: |
subscription
|
path | True |
string |
ID langganan target. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Isi respons berisi entitas Grup yang ditentukan. Header ETag: string |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory.
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
ApiManagementGetGroup
Permintaan sampel
Respon sampel
{
"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
Nama | Deskripsi |
---|---|
Error |
Kontrak Bidang Kesalahan. |
Error |
Respons Kesalahan. |
Group |
Detail kontrak. |
Group |
Jenis grup. |
ErrorFieldContract
Kontrak Bidang Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan tingkat properti. |
message |
string |
Representasi kesalahan tingkat properti yang dapat dibaca manusia. |
target |
string |
Nama properti. |
ErrorResponse
Respons Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
error.code |
string |
Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons. |
error.details |
Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi. |
|
error.message |
string |
Representasi kesalahan yang dapat dibaca manusia. |
GroupContract
Detail kontrak.
Nama | Jenis | Deskripsi |
---|---|---|
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 |
properties.type |
Jenis grup. |
|
type |
string |
Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts" |
GroupType
Jenis grup.
Nama | Jenis | Deskripsi |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |