Resources - List

Dienst:

Resource Management

API-Version:

2021-04-01

Rufen Sie alle Ressourcen in einem Abonnement ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?api-version=2021-04-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter={$filter}&$expand={$expand}&$top={$top}&api-version=2021-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Die Microsoft Azure-Abonnement-ID.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand	query		string	Durch Trennzeichen getrennte Liste zusätzlicher Eigenschaften, die in die Antwort aufgenommen werden sollen. Gültige Werte sind createdTime, changedTime und provisioningState. Beispiel: $expand=createdTime,changedTime.
$filter	query		string	Der filter, der auf den Vorgang angewendet werden soll. Filtervergleichsoperatoren umfassen eq (gleich) und ne (ungleich) und können mit den folgenden Eigenschaften verwendet werden: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionund plan/promotionCode. Um beispielsweise nach einem Ressourcentyp zu filtern, verwenden Sie $filter=resourceType eq 'Microsoft.Network/virtualNetworks' substringof(value, property) können verwendet werden, um nach Teilzeichenfolgen der folgenden derzeit unterstützten Eigenschaften zu filtern: name und resourceGroup Um beispielsweise alle Ressourcen mit "Demo" an einer beliebigen Stelle im Ressourcennamen abzurufen, verwenden Sie $filter=substringof('demo', name) Mehrere Teilzeichenfolgenvorgänge können auch mit and/or Operatoren kombiniert werden. Beachten Sie, dass alle abgeschnittenen Ergebnisse, die über $top abgefragt werden, auch nicht kompatibel sein können, wenn sie einen Filter verwenden. Ressourcen können nach Tagnamen und Werten gefiltert werden. Wenn Sie beispielsweise nach einem Tagnamen und -wert filtern möchten, verwenden Sie $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Beachten Sie, dass beim Filtern von Ressourcen nach Tagname und Wert die ursprünglichen Tags für jede Ressource nicht in den Ergebnissen zurückgegeben werden. Eine Liste mit zusätzlichen Eigenschaften, die über $expand abgefragt werden, kann auch beim Filtern nach Tagnamen/Werten nicht kompatibel sein. Nur für Tagnamen können Ressourcen mithilfe der folgenden Syntax gefiltert werden: $filter=startswith(tagName, 'depart'). Diese Abfrage gibt alle Ressourcen mit einem Tagnamen zurück, dem der Ausdruck depart vorangestellt ist (z. B.department, departureDate, departureTimeusw.) Beachten Sie, dass einige Eigenschaften beim Filtern von Ressourcen kombiniert werden können, die Folgendes umfassen: substringof() and/or resourceType, plan and plan/publisher and plan/nameund identity and identity/principalId.
$top	query		integer (int32)	Die Anzahl der Empfehlungen pro Seite, wenn eine seitenseitige Version dieser API verwendet wird.

Antworten

Name	Typ	Beschreibung
200 OK	ResourceListResult	OK : Gibt ein Array von Ressourcen zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
ExtendedLocation	Erweiterter Ressourcenspeicherort.
ExtendedLocationType	Der erweiterte Standorttyp.
GenericResourceExpanded	Ressourceninformationen.
Identity	Identität für die Ressource.
Plan	Planen Sie die Ressource.
ResourceIdentityType	Der Identitätstyp.
ResourceListResult	Liste der Ressourcengruppen.
Sku	SKU für die Ressource.
UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CloudError

Objekt

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ExtendedLocation

Objekt

Erweiterter Ressourcenspeicherort.

Name	Typ	Beschreibung
name	string	Der Name des erweiterten Speicherorts.
type	ExtendedLocationType	Der erweiterte Standorttyp.

ExtendedLocationType

Enumeration

Der erweiterte Standorttyp.

Wert	Beschreibung
EdgeZone

GenericResourceExpanded

Objekt

Ressourceninformationen.

Name	Typ	Beschreibung
changedTime	string (date-time)	Die geänderte Zeit der Ressource. Dies ist nur vorhanden, wenn sie über den $expand Abfrageparameter angefordert wird.
createdTime	string (date-time)	Die erstellte Zeit der Ressource. Dies ist nur vorhanden, wenn sie über den $expand Abfrageparameter angefordert wird.
extendedLocation	ExtendedLocation	Erweiterter Ressourcenspeicherort.
id	string	Ressourcen-ID
identity	Identity	Die Identität der Ressource.
kind	string pattern: ^[-\w\._,\(\)]+$	Die Art der Ressource.
location	string	Ressourcenspeicherort
managedBy	string	ID der Ressource, die diese Ressource verwaltet.
name	string	Ressourcenname
plan	Plan	Der Plan der Ressource.
properties	object	Die Ressourceneigenschaften.
provisioningState	string	Der Bereitstellungsstatus der Ressource. Dies ist nur vorhanden, wenn sie über den $expand Abfrageparameter angefordert wird.
sku	Sku	Die SKU der Ressource.
tags	object	Ressourcentags
type	string	Ressourcentyp

Identity

Objekt

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität.
tenantId	string	Die Mandanten-ID der Ressource.
type	ResourceIdentityType	Der Identitätstyp.
userAssignedIdentities	UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Plan

Objekt

Planen Sie die Ressource.

Name	Typ	Beschreibung
name	string	Die Plan-ID.
product	string	Die Angebots-ID.
promotionCode	string	Der Heraufsufungscode.
publisher	string	Die Herausgeber-ID.
version	string	Die Version des Plans.

ResourceIdentityType

Enumeration

Der Identitätstyp.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ResourceListResult

Objekt

Liste der Ressourcengruppen.

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll.
value	GenericResourceExpanded[]	Ein Array von Ressourcen.

Sku

Objekt

SKU für die Ressource.

Name	Typ	Beschreibung
capacity	integer (int32)	Die SKU-Kapazität.
family	string	Die SKU-Familie.
model	string	Das SKU-Modell.
name	string	Der SKU-Name.
size	string	Die SKU-Größe.
tier	string	Die SKU-Ebene.

UserAssignedIdentities

Objekt

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Typ	Beschreibung