Entities - List

Referensi

Service:: Management Groups

API Version:: 2020-05-01

Membuat daftar semua entitas (Grup Manajemen, Langganan, dll.) untuk pengguna yang diautentikasi.

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01

With optional parameters:

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01&$skiptoken={$skiptoken}&$skip={$skip}&$top={$top}&$select={$select}&$search={$search}&$filter={$filter}&$view={$view}&groupName={groupName}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah pratinjau 2018-01-01.
$filter	query		string	Parameter filter memungkinkan Anda memfilter bidang nama atau nama tampilan. Anda dapat memeriksa kesetaraan pada bidang nama (misalnya nama eq '{entityName}') dan Anda dapat memeriksa substring pada bidang nama atau nama tampilan(misalnya contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Perhatikan bahwa bidang '{entityName}' dan '{substringToSearch}' diperiksa huruf besar/kecil secara tidak sensitif.
$search	query		string	Parameter $search digunakan bersama dengan parameter $filter untuk mengembalikan tiga output yang berbeda tergantung pada parameter yang diteruskan. Dengan $search=AllowedParents, API akan mengembalikan info entitas dari semua grup yang akan dapat direparasi oleh entitas yang diminta sebagaimana ditentukan oleh izin pengguna. Dengan $search=AllowedChildren, API akan mengembalikan info entitas dari semua entitas yang dapat ditambahkan sebagai turunan dari entitas yang diminta. Dengan $search=ParentAndFirstLevelChildren, API akan mengembalikan induk dan tingkat anak pertama tempat pengguna memiliki akses langsung ke atau tidak langsung melalui salah satu turunannya. Dengan $search=ParentOnly, API hanya akan mengembalikan grup jika pengguna memiliki akses ke setidaknya salah satu turunan grup. Dengan $search=ChildrenOnly, API hanya akan mengembalikan tingkat anak pertama dari info entitas grup yang ditentukan dalam $filter. Pengguna harus memiliki akses langsung ke entitas anak-anak atau salah satu keturunannya agar dapat muncul dalam hasil.
$select	query		string	Parameter ini menentukan bidang yang akan disertakan dalam respons. Dapat menyertakan kombinasi Nama,DisplayName,Type,ParentDisplayNameChain,ParentChain, misalnya '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Ketika ditentukan, parameter $select dapat menimpa pilih di $skipToken.
$skip	query		integer	Jumlah entitas yang akan dilewati saat mengambil hasil. Meneruskan ini akan mengambil alih $skipToken.
$skiptoken	query		string	Token kelanjutan halaman hanya digunakan jika operasi sebelumnya mengembalikan hasil parsial. Jika respons sebelumnya berisi elemen nextLink, nilai elemen nextLink akan menyertakan parameter token yang menentukan titik awal yang akan digunakan untuk panggilan berikutnya.
$top	query		integer	Jumlah elemen yang akan dikembalikan saat mengambil hasil. Meneruskan ini akan mengambil alih $skipToken.
$view	query		string	Parameter tampilan memungkinkan klien untuk memfilter jenis data yang dikembalikan oleh panggilan getEntities.
groupName	query		string	Filter yang memungkinkan panggilan dapatkan entitas untuk fokus pada grup tertentu (yaitu "$filter=name eq 'groupName'")

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Cache-Control		string	Menunjukkan bahwa permintaan tidak boleh menggunakan cache apa pun.

Respons

Nama	Jenis	Deskripsi
200 OK	EntityListResult	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

GetEntities

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "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",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "view",
        "inheritedPermissions": "view",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 1 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group1Tenant2Parent"
        ],
        "numberOfDescendants": 3,
        "numberOfChildren": 2,
        "numberOfChildGroups": 1
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0004-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0004-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 4 Tenant 2",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "delete",
        "inheritedPermissions": "delete",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 4 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group4 Tenant2Parent"
        ],
        "numberOfDescendants": 0,
        "numberOfChildren": 0,
        "numberOfChildGroups": 0
      }
    }
  ],
  "nextLink": null
}

Definisi

Nama	Deskripsi
EntityInfo	Entitas.
EntityListResult	Menjelaskan hasil permintaan untuk melihat entitas.
EntityParentGroupInfo	(Opsional) ID grup manajemen induk.
ErrorDetails	Detail kesalahan.
ErrorResponse	Objek kesalahan.
Permissions	Pengguna memiliki izin khusus untuk item ini.

EntityInfo

Entitas.

Nama	Jenis	Deskripsi
id	string	ID yang sepenuhnya memenuhi syarat untuk entitas. Misalnya, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000
name	string	Nama entitas. Misalnya, 00000000-0000-0000-0000-000000000000
properties.displayName	string	Nama grup manajemen yang mudah diingat.
properties.inheritedPermissions	Permissions	Izin yang Diwariskan Pengguna memiliki izin khusus untuk item ini.
properties.numberOfChildGroups	integer	Jumlah Grup Anak Jumlah anak adalah jumlah Grup yang tepat satu tingkat di bawah Grup saat ini.
properties.numberOfChildren	integer	Jumlah Anak Jumlah anak adalah jumlah Grup dan Langganan yang persis satu tingkat di bawah Grup saat ini.
properties.numberOfDescendants	integer	Jumlah Turunan
properties.parent	EntityParentGroupInfo	Parent (Opsional) ID grup manajemen induk.
properties.parentDisplayNameChain	string[]	Rantai nama tampilan induk dari grup akar ke induk langsung
properties.parentNameChain	string[]	Rantai nama induk dari grup akar ke induk langsung
properties.permissions	Permissions	Izin Pengguna memiliki izin khusus untuk item ini.
properties.tenantId	string	ID Penyewa AAD yang terkait dengan entitas. Misalnya, 00000000-0000-0000-0000-000000000000
type	string	Jenis sumber daya. Misalnya, Microsoft.Management/managementGroups

EntityListResult

Menjelaskan hasil permintaan untuk melihat entitas.

Nama	Jenis	Deskripsi
count	integer	Jumlah total rekaman yang cocok dengan filter
nextLink	string	URL yang digunakan untuk mendapatkan serangkaian hasil berikutnya.
value	EntityInfo[]	Daftar entitas.

EntityParentGroupInfo

(Opsional) ID grup manajemen induk.

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

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.

Permissions

Pengguna memiliki izin khusus untuk item ini.

Nama	Jenis	Deskripsi
delete	string
edit	string
noaccess	string
view	string