Entities - List
Kimliği doğrulanmış kullanıcının tüm varlıklarını (Yönetim Grupları, Abonelikler vb.) listeleyin.
POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01
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}
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
İstemci isteğiyle kullanılacak API'nin sürümü. Geçerli sürüm 2018-01-01-preview sürümüdür. |
$filter
|
query |
string |
filter parametresi, ad veya görünen ad alanlarını filtrelemenize olanak tanır. Ad alanında (ör. '{entityName}' adı) eşitliği denetleyebilirsiniz ve ad veya görünen ad alanlarında (örn. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')) alt dizeleri de kontrol edebilirsiniz. '{entityName}' ve '{substringToSearch}' alanlarının büyük/küçük harfe duyarsız bir şekilde denetlendiğini unutmayın. |
|
$search
|
query |
string |
$search parametresi, geçirilen parametreye bağlı olarak üç farklı çıkış döndürmek için $filter parametresiyle birlikte kullanılır. $search=AllowedParents ile API, istenen varlığın kullanıcının izinleri tarafından belirlenen şekilde yeniden ayrıştırabileceği tüm grupların varlık bilgilerini döndürür. $search=AllowedChildren ile API, istenen varlığın alt öğeleri olarak eklenebilen tüm varlıkların varlık bilgilerini döndürür. $search=ParentAndFirstLevelChildren ile API, kullanıcının alt öğelerinden biri aracılığıyla doğrudan veya dolaylı erişime sahip olduğu üst ve ilk alt düzeylerini döndürür. $search=ParentOnly ile API yalnızca kullanıcının grubun alt öğelerinden en az birine erişimi varsa grubu döndürür. $search=ChildrenOnly ile API, $filter'de belirtilen grup varlığı bilgilerinin yalnızca ilk alt düzeylerini döndürür. Kullanıcının alt varlıklara veya alt öğelerden birine doğrudan erişimi olmalıdır. |
|
$select
|
query |
string |
Bu parametre, yanıta eklenecek alanları belirtir. Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, örneğin '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain' birleşimini içerebilir. Belirtildiğinde, $select parametresi $skipToken'de seçimi geçersiz kılabilir. |
|
$skip
|
query |
integer |
Sonuçlar alınırken atlanması gereken varlık sayısı. Bunu içeri geçirmek $skipToken geçersiz kılar. |
|
$skiptoken
|
query |
string |
Sayfa devamlılığı belirteci yalnızca önceki bir işlemin kısmi bir sonuç döndürmesi durumunda kullanılır. Önceki yanıt bir nextLink öğesi içeriyorsa, nextLink öğesinin değeri sonraki çağrılar için kullanılacak bir başlangıç noktasını belirten bir belirteç parametresi içerir. |
|
$top
|
query |
integer |
Sonuçlar alınırken döndürülecek öğe sayısı. Bunu içeri geçirmek $skipToken geçersiz kılar. |
|
$view
|
query |
string |
görünüm parametresi, istemcilerin getEntities çağrısı tarafından döndürülen veri türünü filtrelemesine olanak tanır. |
|
group
|
query |
string |
Get varlıklarının belirli bir gruba odaklanmasını sağlayan bir filtre (örneğin, "$filter=name eq 'groupName'") |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
Cache-Control |
string |
İsteğin önbellek kullanmaması gerektiğini gösterir. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Tamam |
|
Other Status Codes |
Hata |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
GetEntities
Örnek isteği
POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01
Örnek yanıt
{
"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
}
Tanımlar
Name | Description |
---|---|
Entity |
Varlık. |
Entity |
Varlıkları görüntüleme isteğinin sonucunu açıklar. |
Entity |
(İsteğe bağlı) Üst yönetim grubunun kimliği. |
Error |
Hatanın ayrıntıları. |
Error |
Hata nesnesi. |
Permissions |
Kullanıcılara özel bu öğe izinleri. |
EntityInfo
Varlık.
Name | Tür | Description |
---|---|---|
id |
string |
Varlığın tam kimliği. Örneğin, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-0000000000000 |
name |
string |
Varlık adı. Örneğin, 00000000-0000-0000-0000-0000000000000 |
properties.displayName |
string |
Yönetim grubunun kolay adı. |
properties.inheritedPermissions |
Devralınan İzinler |
|
properties.numberOfChildGroups |
integer |
Alt Grup Sayısı |
properties.numberOfChildren |
integer |
Çocuk Sayısı |
properties.numberOfDescendants |
integer |
Alt Öğe Sayısı |
properties.parent |
Parent |
|
properties.parentDisplayNameChain |
string[] |
Kök gruptan hemen üst öğeye üst görünen ad zinciri |
properties.parentNameChain |
string[] |
Kök gruptan hemen üst öğeye üst ad zinciri |
properties.permissions |
İzinler |
|
properties.tenantId |
string |
Varlıkla ilişkili AAD Kiracı Kimliği. Örneğin, 00000000-0000-0000-0000-0000000000000 |
type |
string |
Kaynağın türü. Örneğin, Microsoft.Management/managementGroups |
EntityListResult
Varlıkları görüntüleme isteğinin sonucunu açıklar.
Name | Tür | Description |
---|---|---|
count |
integer |
Filtreyle eşleşen kayıtların toplam sayısı |
nextLink |
string |
Sonraki sonuç kümesini almak için kullanılacak URL. |
value |
Varlık listesi. |
EntityParentGroupInfo
(İsteğe bağlı) Üst yönetim grubunun kimliği.
Name | Tür | Description |
---|---|---|
id |
string |
Üst yönetim grubu için tam kimlik. Örneğin, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-0000000000000 |
ErrorDetails
Hatanın ayrıntıları.
Name | Tür | Description |
---|---|---|
code |
string |
Sunucu tanımlı hata kodları kümesinden biri. |
details |
string |
Hatanın ayrıntılarının insan tarafından okunabilen bir gösterimi. |
message |
string |
Hatanın insan tarafından okunabilen bir gösterimi. |
ErrorResponse
Hata nesnesi.
Name | Tür | Description |
---|---|---|
error |
Hata |
Permissions
Kullanıcılara özel bu öğe izinleri.
Name | Tür | Description |
---|---|---|
delete |
string |
|
edit |
string |
|
noaccess |
string |
|
view |
string |