Management Groups - Get

Dapatkan detail grup manajemen.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}?api-version=2020-05-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}?api-version=2020-05-01&$expand={$expand}&$recurse={$recurse}&$filter={$filter}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
groupId
path True

string

ID Grup Manajemen.

api-version
query True

string

Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah pratinjau 2018-01-01.

$expand
query

string

Parameter string kueri $expand=children memungkinkan klien untuk meminta penyertaan anak-anak dalam payload respons. $expand=path menyertakan jalur dari grup akar ke grup saat ini.

$filter
query

string

Filter yang memungkinkan pengecualian langganan dari hasil (yaitu '$filter=children.childType ne Subscription')

$recurse
query

boolean

Parameter string kueri $recurse=true memungkinkan klien untuk meminta penyertaan seluruh hierarki dalam payload respons. Perhatikan bahwa $expand=children harus diteruskan jika $recurse diatur ke true.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
Cache-Control

string

Menunjukkan bahwa permintaan tidak boleh menggunakan cache apa pun.

Respons

Nama Jenis Deskripsi
200 OK

ManagementGroup

OK

Other Status Codes

ErrorResponse

Kesalahan

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

GetManagementGroup
GetManagementGroupsWithExpandAndRecurse
GetManagementGroupWithExpand

GetManagementGroup

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000?api-version=2020-05-01

Sample Response

{
  "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000",
  "type": "Microsoft.Management/managementGroups",
  "name": "20000000-0001-0000-0000-000000000000",
  "properties": {
    "tenantId": "20000000-0000-0000-0000-000000000000",
    "displayName": "Group 1 Tenant 2",
    "details": {
      "version": 1,
      "updatedTime": "2018-01-01T00:00:00.00Z",
      "updatedBy": "16b8ef21-5c9f-420c-bcc9-e4f8c9f30b4b",
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/RootGroup",
        "name": "RootGroup",
        "displayName": "RootGroup"
      }
    }
  }
}

GetManagementGroupsWithExpandAndRecurse

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000?api-version=2020-05-01&$expand=children&$recurse=True

Sample Response

{
  "id": "/providers/Microsoft.Management/managementGroups/RootGroup",
  "type": "Microsoft.Management/managementGroups",
  "name": "RootGroup",
  "properties": {
    "tenantId": "20000000-0000-0000-0000-000000000000",
    "displayName": "RootGroup",
    "details": {
      "version": 2,
      "updatedTime": "2018-01-25T02:26:49.0022093Z",
      "updatedBy": "bd490e30-04cb-433e-b8c8-6066959a8bab",
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000",
        "name": "20000000-0000-0000-0000-000000000000",
        "displayName": "20000000-0000-0000-0000-000000000000"
      }
    },
    "children": [
      {
        "id": "/providers/Microsoft.Management/managementGroups/Child",
        "type": "Microsoft.Management/managementGroups",
        "name": "Child",
        "displayName": "Child",
        "children": [
          {
            "id": "/providers/Microsoft.Management/managementGroups/Leaf",
            "type": "Microsoft.Management/managementGroups",
            "name": "Leaf",
            "displayName": "Leaf",
            "children": [
              {
                "id": "/subscriptions/728bcbe4-8d56-4510-86c2-4921b8beefbc",
                "type": "/subscriptions",
                "name": "728bcbe4-8d56-4510-86c2-4921b8beefbc",
                "displayName": "Pay-As-You-Go"
              }
            ]
          }
        ]
      },
      {
        "id": "/providers/Microsoft.Management/managementGroups/AnotherChild",
        "type": "Microsoft.Management/managementGroups",
        "name": "AnotherChild",
        "displayName": "Leaf"
      }
    ]
  }
}

GetManagementGroupWithExpand

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000?api-version=2020-05-01&$expand=children

Sample Response

{
  "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000",
  "type": "Microsoft.Management/managementGroups",
  "name": "20000000-0001-0000-0000-000000000000",
  "properties": {
    "tenantId": "20000000-0000-0000-0000-000000000000",
    "displayName": "Group 1 Tenant 2",
    "details": {
      "version": 1,
      "updatedTime": "2018-01-01T00:00:00.00Z",
      "updatedBy": "Test",
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000",
        "name": "20000000-0000-0000-0000-000000000000",
        "displayName": "20000000-0000-0000-0000-000000000000"
      }
    },
    "children": [
      {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0002-0000-0000-000000000000",
        "type": "Microsoft.Management/managementGroups",
        "name": "20000000-0002-0000-0000-000000000000",
        "displayName": "Group 2 Tenant 2"
      },
      {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0003-0000-0000-000000000000",
        "type": "Microsoft.Management/managementGroups",
        "name": "20000000-0003-0000-0000-000000000000",
        "displayName": "Group 3 Tenant 2"
      },
      {
        "id": "/subscriptions/10000000-F004-0000-0000-000000000000",
        "type": "/subscriptions",
        "name": "10000000-F004-0000-0000-000000000000",
        "displayName": "Subscription 4 Tenant 1"
      },
      {
        "id": "/subscriptions/20000000-F005-0000-0000-000000000000",
        "type": "/subscriptions",
        "name": "20000000-F005-0000-0000-000000000000",
        "displayName": "Subscription 5 Tenant 2"
      },
      {
        "id": "/subscriptions/30000000-F003-0000-0000-000000000000",
        "type": "/subscriptions",
        "name": "30000000-F003-0000-0000-000000000000",
        "displayName": "Subscription 3 Tenant 3"
      }
    ]
  }
}

Definisi

Nama Deskripsi
ErrorDetails

Detail kesalahan.

ErrorResponse

Objek kesalahan.

ManagementGroup

Detail grup manajemen.

ManagementGroupChildInfo

Informasi anak dari grup manajemen.

ManagementGroupChildType

Jenis sumber daya anak.

ManagementGroupDetails

Detail grup manajemen.

ManagementGroupPathElement

Elemen jalur dari leluhur grup manajemen.

ParentGroupInfo

(Opsional) ID grup manajemen induk.

ErrorDetails

Detail kesalahan.

Nama Jenis Deskripsi
code

string

Salah satu set kode kesalahan yang ditentukan server.

details

string

Representasi yang dapat dibaca manusia dari detail kesalahan.

message

string

Representasi kesalahan yang dapat dibaca manusia.

ErrorResponse

Objek kesalahan.

Nama Jenis Deskripsi
error

ErrorDetails

Kesalahan
Detail kesalahan.

ManagementGroup

Detail grup manajemen.

Nama Jenis Deskripsi
id

string

ID yang sepenuhnya memenuhi syarat untuk grup manajemen. Misalnya, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000

name

string

Nama grup manajemen. Misalnya, 00000000-0000-0000-0000-000000000000

properties.children

ManagementGroupChildInfo[]

Daftar anak-anak.

properties.details

ManagementGroupDetails

Detail
Detail grup manajemen.

properties.displayName

string

Nama grup manajemen yang mudah diingat.

properties.tenantId

string

ID Penyewa AAD yang terkait dengan grup manajemen. Misalnya, 00000000-0000-0000-0000-000000000000

type

string

Jenis sumber daya. Misalnya, Microsoft.Management/managementGroups

ManagementGroupChildInfo

Informasi anak dari grup manajemen.

Nama Jenis Deskripsi
children

ManagementGroupChildInfo[]

Daftar anak-anak.

displayName

string

Nama sumber daya anak yang mudah diingat.

id

string

ID yang sepenuhnya memenuhi syarat untuk sumber daya anak (grup manajemen atau langganan). Misalnya, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000

name

string

Nama entitas anak.

type

ManagementGroupChildType

Jenis sumber daya anak.
Jenis sumber daya yang sepenuhnya memenuhi syarat yang mencakup namespace penyedia (misalnya Microsoft.Management/managementGroups)

ManagementGroupChildType

Jenis sumber daya anak.

Nama Jenis Deskripsi
/subscriptions

string

Microsoft.Management/managementGroups

string

ManagementGroupDetails

Detail grup manajemen.

Nama Jenis Deskripsi
parent

ParentGroupInfo

Parent
(Opsional) ID grup manajemen induk.

path

ManagementGroupPathElement[]

Jalur dari akar ke grup saat ini.

updatedBy

string

Identitas prinsipal atau proses yang memperbarui objek.

updatedTime

string

Tanggal dan waktu saat objek ini terakhir diperbarui.

version

number

Nomor versi objek.

ManagementGroupPathElement

Elemen jalur dari leluhur grup manajemen.

Nama Jenis Deskripsi
displayName

string

Nama grup yang mudah diingat.

name

string

Nama grup.

ParentGroupInfo

(Opsional) ID grup manajemen induk.

Nama Jenis Deskripsi
displayName

string

Nama yang mudah diingat dari grup manajemen induk.

id

string

ID yang sepenuhnya memenuhi syarat untuk grup manajemen induk. Misalnya, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000

name

string

Nama grup manajemen induk