Entities - List

Referens

Tjänst:: Management Groups

API-version:: 2020-05-01

Visa en lista över alla entiteter (hanteringsgrupper, prenumerationer osv.) för den autentiserade användaren.

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

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2018-01-01-preview.
$filter	query		string	Med filterparametern kan du filtrera efter fälten för namn eller visningsnamn. Du kan söka efter likhet i namnfältet (t.ex. namn eq {entityName}) och du kan söka efter delsträngar i antingen namn- eller visningsnamnfälten(t.ex. contains(name, {substringToSearch}), contains(displayName, {substringToSearch)). Observera att fälten {entityName} och {substringToSearch} är insokänsliga.
$search	query		string	Parametern $search används tillsammans med parametern $filter för att returnera tre olika utdata beroende på vilken parameter som skickades. Med $search=AllowedParents returnerar API:et entitetsinformationen för alla grupper som den begärda entiteten kommer att kunna återgå till enligt användarens behörigheter. Med $search=AllowedChildren returnerar API:et entitetsinformation för alla entiteter som kan läggas till som underordnade till den begärda entiteten. Med $search=ParentAndFirstLevelChildren returnerar API:et den överordnade och första nivån av underordnade som användaren antingen har direkt åtkomst till eller indirekt åtkomst via någon av sina underordnade. Med $search=ParentOnly returnerar API:et endast gruppen om användaren har åtkomst till minst en av de underordnade i gruppen. Med $search=ChildrenOnly returnerar API:et endast den första nivån av underordnade i gruppentitetsinformationen som anges i $filter. Användaren måste ha direkt åtkomst till underordnade entiteter eller någon av de underordnade för att den ska visas i resultatet.
$select	query		string	Den här parametern anger vilka fält som ska ingå i svaret. Kan innehålla valfri kombination av Namn,DisplayName,Typ,ParentDisplayNameChain,ParentChain, t.ex. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. När den har angetts kan parametern $select åsidosätta valet i $skipToken.
$skip	query		integer	Antal entiteter att hoppa över när resultat hämtas. Om du skickar in detta åsidosätts $skipToken.
$skiptoken	query		string	Sidfortsättningstoken används endast om en tidigare åtgärd returnerade ett partiellt resultat. Om ett tidigare svar innehåller ett nextLink-element innehåller värdet för nextLink-elementet en tokenparameter som anger en startpunkt som ska användas för efterföljande anrop.
$top	query		integer	Antal element som ska returneras vid hämtning av resultat. Om du skickar in detta åsidosätts $skipToken.
$view	query		string	Med vyparametern kan klienter filtrera den typ av data som returneras av getEntities-anropet.
groupName	query		string	Ett filter som gör att anropet hämta entiteter kan fokusera på en viss grupp (dvs. "$filter=name eq 'groupName'")

Begärandehuvud

Name	Obligatorisk	Typ	Description
Cache-Control		string	Anger att begäran inte ska använda några cacheminnen.

Svar

Name	Typ	Description
200 OK	EntityListResult	OK
Other Status Codes	ErrorResponse	Fel

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GetEntities

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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
}

Definitioner

Name	Description
EntityInfo	Entiteten.
EntityListResult	Beskriver resultatet av begäran om att visa entiteter.
EntityParentGroupInfo	(Valfritt) ID för den överordnade hanteringsgruppen.
ErrorDetails	Information om felet.
ErrorResponse	Felobjektet.
Permissions	Användarnas specifika behörigheter för det här objektet.

EntityInfo

Entiteten.

Name	Typ	Description
id	string	Det fullständigt kvalificerade ID:t för entiteten. Till exempel /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000
name	string	Namnet på entiteten. Till exempel 000000000-0000-0000-0000-0000000000000000
properties.displayName	string	Hanteringsgruppens eget namn.
properties.inheritedPermissions	Permissions	Ärvda behörigheter Användarnas specifika behörigheter för det här objektet.
properties.numberOfChildGroups	integer	Antal underordnade grupper Antal underordnade är antalet grupper som är exakt en nivå under den aktuella gruppen.
properties.numberOfChildren	integer	Antal barn Antal underordnade är antalet grupper och prenumerationer som är exakt en nivå under den aktuella gruppen.
properties.numberOfDescendants	integer	Antal underordnade
properties.parent	EntityParentGroupInfo	Överordnad (Valfritt) ID för den överordnade hanteringsgruppen.
properties.parentDisplayNameChain	string[]	Den överordnade visningsnamnkedjan från rotgruppen till den omedelbara överordnade
properties.parentNameChain	string[]	Den överordnade namnkedjan från rotgruppen till den omedelbara överordnade
properties.permissions	Permissions	Behörigheter Användarnas specifika behörigheter för det här objektet.
properties.tenantId	string	Det AAD-klient-ID som är associerat med entiteten. Till exempel 000000000-0000-0000-0000-0000000000000000
type	string	Resurstypen. Till exempel Microsoft.Management/managementGroups

EntityListResult

Beskriver resultatet av begäran om att visa entiteter.

Name	Typ	Description
count	integer	Totalt antal poster som matchar filtret
nextLink	string	Url:en som ska användas för att hämta nästa uppsättning resultat.
value	EntityInfo[]	Listan över entiteter.

EntityParentGroupInfo

(Valfritt) ID för den överordnade hanteringsgruppen.

Name	Typ	Description
id	string	Det fullständigt kvalificerade ID:t för den överordnade hanteringsgruppen. Till exempel /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	string	En läsbar återgivning av felinformationen.
message	string	En läsbar återgivning av felet.

ErrorResponse

Felobjektet.

Name	Typ	Description
error	ErrorDetails	Fel Information om felet.

Permissions

Användarnas specifika behörigheter för det här objektet.

Name	Typ	Description
delete	string
edit	string
noaccess	string
view	string

Dela via