Graph Query - Get

服務:

Azure Resource Graph

API 版本:

2024-04-01

依其 resourceName 取得單一圖表查詢。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
resourceName	path	True	string pattern: ^[^<>&:\?]*$	Graph 查詢資源的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	GraphQueryResource	圖形查詢定義。
Other Status Codes	GraphQueryError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get Graph Query

範例要求

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

範例回覆

狀態碼:

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"
  }
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
Error	error 物件。
ErrorFieldContract	錯誤欄位合約。
GraphQueryError	錯誤訊息本文，指出作業失敗的原因。
GraphQueryResource	圖形查詢實體定義。
ResultKind	列舉，指出圖形查詢的類型。
systemData	與建立和上次修改資源相關的元數據。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

Error

Object

error 物件。

名稱	類型	Description
code	string	服務定義的錯誤碼。 此程式代碼可作為回應中所指定 HTTP 錯誤碼的子狀態。
details	ErrorFieldContract[]	要求中傳送無效欄位的清單，以防驗證錯誤。
message	string	人類可讀取的錯誤表示法。

ErrorFieldContract

Object

錯誤欄位合約。

名稱	類型	Description
code	string	屬性層級錯誤碼。
message	string	人類可讀取的屬性層級錯誤表示法。
target	string	屬性名稱。

GraphQueryError

Object

錯誤訊息本文，指出作業失敗的原因。

名稱	類型	Description
error	Error	error 物件。

GraphQueryResource

Object

圖形查詢實體定義。

名稱	類型	Description
etag	string	這會用來處理開放式並行存取。 如果沒有，它一律會覆寫現有的資源，而不會檢查衝突。
id	string	Azure 資源標識碼
location	string	資源的位置
name	string	Azure 資源名稱。 這是 GUID 值。 顯示名稱應該在 [屬性] 欄位中指派。
properties.description	string	圖形查詢的描述。
properties.query	string	將會是圖形的 KQL 查詢。
properties.resultKind	ResultKind	列舉，指出圖形查詢的類型。
properties.timeModified	string (date-time)	上次修改此圖形查詢定義的UTC日期和時間。
systemData	systemData	與此資源相關的系統元數據。
tags	object	資源標籤
type	string	Azure 資源類型

ResultKind

列舉型別

列舉，指出圖形查詢的類型。

值	Description
basic

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。