Graph Query - Get

Usługa:

Azure Resource Graph

Wersja interfejsu API:

2024-04-01

Pobierz pojedyncze zapytanie grafu według jego resourceName.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries/{resourceName}?api-version=2024-04-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
resourceName	path	True	string pattern: ^[^<>&:\?]*$	Nazwa zasobu zapytania programu Graph.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GraphQueryResource	Definicja zapytania grafu.
Other Status Codes	GraphQueryError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get Graph Query

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resourceGroups/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs?api-version=2024-04-01

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs",
  "name": "MyDockerVMs",
  "type": "Microsoft.ResourceGraph/queries",
  "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa",
  "tags": null,
  "properties": {
    "description": "Docker VMs in PROD",
    "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'",
    "resultKind": "basic",
    "timeModified": "2019-03-12T13:51:13-07:00"
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
Error	Obiekt błędu.
ErrorFieldContract	Błąd Kontrakt pola.
GraphQueryError	Treść komunikatu o błędzie wskazująca, dlaczego operacja nie powiodła się.
GraphQueryResource	Definicja jednostki zapytania programu Graph.
ResultKind	Wyliczenie wskazujące typ zapytania grafu.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
details	ErrorFieldContract[]	Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.
message	string	Czytelna dla człowieka reprezentacja błędu.

ErrorFieldContract

Objekt

Błąd Kontrakt pola.

Nazwa	Typ	Opis
code	string	Kod błędu poziomu właściwości.
message	string	Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target	string	Nazwa właściwości.

GraphQueryError

Objekt

Treść komunikatu o błędzie wskazująca, dlaczego operacja nie powiodła się.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

GraphQueryResource

Objekt

Definicja jednostki zapytania programu Graph.

Nazwa	Typ	Opis
etag	string	Będzie to używane do obsługi optymistycznej współbieżności. Jeśli nie istnieje, zawsze zastąpi istniejący zasób bez sprawdzania konfliktu.
id	string	Identyfikator zasobu platformy Azure
location	string	Lokalizacja zasobu
name	string	Nazwa zasobu platformy Azure. Jest to wartość identyfikatora GUID. Nazwa wyświetlana powinna być przypisana w polu właściwości.
properties.description	string	Opis zapytania grafu.
properties.query	string	Zapytanie KQL, które będzie grafem.
properties.resultKind	ResultKind	Wyliczenie wskazujące typ zapytania grafu.
properties.timeModified	string (date-time)	Data i godzina w formacie UTC ostatniej modyfikacji wprowadzonej w tej definicji zapytania grafu.
systemData	systemData	Metadane systemowe odnoszące się do tego zasobu.
tags	object	Tagi zasobów
type	string	Typ zasobu platformy Azure

ResultKind

Wyliczanie

Wyliczenie wskazujące typ zapytania grafu.

Wartość	Opis
basic

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.