Azure 監視器記錄上的系統函式
本文說明如何使用系統函式在 Azure 監視器記錄上撰寫自定義查詢。
Azure 備份提供一組函式，稱為系統函式或解決方案函式，根據預設，可以直接在 Log Analytics (LA) 工作區中使用。
這些函式會使用 LA 中原始 Azure 備份資料表內的資料，然後傳回格式化後的資料，讓您只要使用簡單的查詢，就能輕鬆擷取您所有備份相關實體的資訊。 使用者可以傳遞參數給這些函式，以篩選這些函式傳回的資料。
建議您使用系統函式來查詢 LA 工作區中的備份數據，以建立自定義報表，因為它們提供許多優點，如下一節所述。
使用系統函式的好處
查詢更容易：使用函式有助於減少查詢中所需的聯結數。 根據預設，函式會傳回「壓平合併」的結構描述，其中包含所查詢之實體 (備份執行個體、工作、保存庫等) 的所有相關資訊。 例如，若您需要取得成功備份工作的清單，並依備份項目名稱及其相關容器排序，只要呼叫 _AzureBackup_getJobs () 函式，就能為各項工作提供此等資訊。 此外，直接查詢原始資料表還需要您為 AddonAzureBackupJobs 和 CoreAzureBackup 資料表執行多項聯結。
順利從舊版診斷事件轉換：使用系統函式可協助您順利從舊版診斷事件 (AzureDiagnostics 模式中的 AzureBackupReport)，轉換至資源特定事件。 Azure 備份提供的所有系統函式，皆可讓您指定參數，以便選擇當函式執行查詢時，只要查詢資源特定資料表中的資料，還是要同時查詢舊版資料表和資源特定資料表 (包含重複資料刪除記錄) 中的資料。
- 若您已成功移轉至資源特定資料表，可以選擇讓函式在查詢時排除舊版資料表。
- 如果您目前正在進行移轉，並在需要分析的舊版數據表中有一些數據，您可以選擇包含舊版數據表。 當轉換完成且不再需要舊版數據表的數據時，您可以更新傳遞至查詢中函式的參數值，以排除舊版數據表。
- 如果您仍然只使用舊版數據表，如果您選擇透過相同的參數包含舊版數據表，函式仍會運作。 不過，建議您 儘早切換至資源特定的數據表 。
降低自訂查詢中斷的可能性：若 Azure 備份改進了基礎 LA 資料表的結構描述，以配合日後的報表案例，函式的定義也勢必會隨之更新，才能配合結構描述的變更。 因此，如果您使用系統函式來建立自定義查詢，即使數據表的基礎架構有變更，您的查詢也不會中斷。
注意
系統函式由 Microsoft 維護，使用者無法編輯其定義。 若您需要編輯函式，可以在 LA 中建立預存函式。
Azure 備份提供的系統函式類型
核心函式：這些函式可讓您查詢任何主要的 Azure 備份實體，例如備份執行個體、保存庫、原則、工作和計費實體。 例如 _AzureBackup_getBackupInstances 函式會傳回環境中截至最近完成日 (UTC) 的所有備份執行個體清單。 下文將摘要說明這些核心函式的參數及其傳回的結構描述。
趨勢函式：這些函式會傳回備份相關實體的歷程記錄 (例如備份執行個體、計費群組等)，讓您可以獲取重要計量資料 (例如計數、所取用的儲存體等) 的每日、每週和每月趨勢資訊。 下文將摘要說明這些趨勢函式的參數及其傳回的結構描述。
注意
目前，系統函式會傳回截至最近完成日 (UTC) 的資料。 但不會傳回尚未結束的當日資料。 因此，若您想要擷取當日的記錄，必須使用原始的 LA 資料表。
系統函式清單
核心函式
_AzureBackup_GetVaults()
此函式會傳回 Azure 環境中，所有 LA 工作區相關復原服務保存庫的清單。
參數
| 參數名稱 | 說明 | [必要？] | 範例值 | 資料類型 |
|---|---|---|---|---|
| RangeStart | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的保存庫相關記錄時，才需使用此參數搭配 RrangeEnd 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，如此函式便只會擷取每個保存庫的最新記錄。 | 否 | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的保存庫相關記錄時，才需使用此參數搭配 RangeStart 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，如此函式便只會擷取每個保存庫的最新記錄。 | 否 | "2021-03-10 00:00:00" | Datetime |
| VaultSubscriptionList | 此參數可針對備份資料所在的特定一組訂閱項目，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的訂閱識別碼清單作為參數，即可只擷取指定訂閱中的保存庫。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有訂閱中的記錄。 | 否 | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | 此參數可針對備份資料所在的特定一組區域，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的區域清單作為參數，即可只擷取指定區域中的保存庫。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有區域中的記錄。 | 否 | eastus,westus |
String |
| VaultList | 此參數可針對特定一組保存庫，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的保存庫名稱清單作為參數，即可只擷取指定保存庫中的記錄。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有保存庫中的記錄。 | 否 | vault1,vault2,vault3 |
String |
| VaultTypeList | 此參數可用於篩選特定保存庫類型相關記錄的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋復原服務保存庫和備份保存庫。 | 否 | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | 此參數可用於選擇是否要查詢舊版 AzureDiagnostics 資料表中的資料。 若此參數的值為 false，函式會同時查詢 AzureDiagnostics 資料表和資源特定資料表中的資料。 若此參數的值為 true，此函式只會查詢資源特定資料表中的資料。 預設值為 True。 | 否 | true | 布林值 |
傳回的欄位
| 欄位名稱 | 說明 | 資料類型 |
|---|---|---|
| UniqueId | 代表保存庫專用識別碼的主索引鍵 | String |
| Id | 保存庫的 Azure Resource Manager (ARM) 識別碼 | String |
| 名稱 | 保存庫名稱 | String |
| SubscriptionId | 保存庫所在訂閱的識別碼 | String |
| Location | 保存庫所在的位置 | String |
| VaultStore_StorageReplicationType | 保存庫相關的儲存體複寫類型 | String |
| 標籤 | 保存庫的標籤 | String |
| TimeGenerated | 記錄的時間戳記 | Datetime |
| 類型 | 保存庫類型，例如 “Microsoft.RecoveryServices/vaults” 或 “Microsoft.DataProtection/backupVaults” | String |
_AzureBackup_GetPolicies()
此函式會傳回您 Azure 環境中目前使用的備份原則清單，以及每項原則的詳細資訊，例如資料來源類型、儲存體複寫類型等。
參數
| 參數名稱 | 說明 | [必要？] | 範例值 | 資料類型 |
|---|---|---|---|---|
| RangeStart | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的原則相關記錄時，才需使用此參數搭配 RrangeStart 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，表示函式只會擷取每項原則的最新記錄。 | 否 | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的原則相關記錄時，才需使用此參數搭配 RrangeStart 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，表示函式只會擷取每項原則的最新記錄。 | 否 | "2021-03-10 00:00:00" | Datetime |
| VaultSubscriptionList | 此參數可針對備份資料所在的特定一組訂閱項目，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的訂閱識別碼清單作為參數，即可只擷取指定訂閱中的原則。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有訂閱中的記錄。 | 否 | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | 此參數可針對備份資料所在的特定一組區域，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的區域清單作為參數，即可只擷取指定區域中的原則。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有區域中的記錄。 | 否 | eastus,westus |
String |
| VaultList | 此參數可針對特定一組保存庫，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的保存庫名稱清單作為參數，即可只擷取指定保存庫相關的原則記錄。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有保存庫中的原則記錄。 | 否 | vault1,vault2,vault3 |
String |
| VaultTypeList | 此參數可用於篩選特定保存庫類型相關記錄的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋復原服務保存庫和備份保存庫。 | 否 | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | 此參數可用於選擇是否要查詢舊版 AzureDiagnostics 資料表中的資料。 若此參數的值為 false，函式會同時查詢 AzureDiagnostics 資料表和資源特定資料表中的資料。 若此參數的值為 true，此函式只會查詢資源特定資料表中的資料。 預設值為 True。 | 否 | true | 布林值 |
| BackupSolutionList | 此參數可針對您 Azure 環境中使用的特定一組備份解決方案，篩選函式查詢的輸出結果。 例如，若您指定 Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM 作為此參數的值，此函式回傳給 Azure 備份的記錄中，只會包含使用 Azure 虛擬機器備份、Azure VM 備份中的 SQL 或 DPM 所備份的項目。 根據預設，此參數的值為 ‘*'，表示函式會傳回備份報告所支援的所有備份解決方案相關記錄 (支援的值為 "Azure Virtual Machine Backup"、"SQL in Azure VM Backup"、"SAP HANA in Azure VM Backup"、"Azure Storage (Azure Files) Backup"、"Azure Backup Agent"、"DPM"、"Azure Backup Server"、"Azure Database for PostgreSQL Server Backup"、"Azure Blob Backup"，或以逗號分隔的前述任意值組合)。 |
否 | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
傳回的欄位
| 欄位名稱 | 說明 | **資料類型** |
|---|---|---|
| UniqueId | 代表原則專用識別碼的主索引鍵 | String |
| Id | 原則的 Azure Resource Manager (ARM) 識別碼 | String |
| 名稱 | 原則的名稱 | String |
| 時區 | 定義原則的時區 | String |
| 備份解決方案 | 原則相關的備份方案。 例如 Azure VM 備份、Azure VM 備份中的 SQL 等。 | String |
| TimeGenerated | 記錄的時間戳記 | Datetime |
| VaultUniqueId | 此外部索引鍵會參考原則相關的保存庫 | String |
| VaultResourceId | 原則相關保存庫的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultName | 原則相關保存庫的名稱 | String |
| VaultTags | 原則相關保存庫的標籤 | String |
| VaultLocation | 原則相關保存庫的位置 | String |
| VaultSubscriptionId | 原則相關保存庫的訂閱識別碼 | String |
| VaultStore_StorageReplicationType | 原則相關保存庫的儲存體複寫類型 | String |
| VaultType | 保存庫類型，例如 “Microsoft.RecoveryServices/vaults” 或 “Microsoft.DataProtection/backupVaults” | String |
| ExtendedProperties | 原則的其他屬性 | 動態 |
_AzureBackup_GetJobs()
此函式會傳回在指定時間範圍內觸發之所有備份和還原相關工作的清單，以及每項工作的詳細資訊，例如工作狀態、工作持續時間、傳輸的資料等。
參數
| 參數名稱 | 說明 | [必要？] | 範例值 | **資料類型** |
|---|---|---|---|---|
| RangeStart | 此參數搭配 RangeEnd 參數，可以擷取所有從 RangeStart 到 RangeEnd 期間內啟動的工作清單。 | Y | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | 此參數搭配 RangeStart 參數，可以擷取從 RangeStart 到 RangeEnd 期間內啟動的所有工作清單。 | Y | "2021-03-10 00:00:00" | Datetime |
| VaultSubscriptionList | 此參數可針對備份資料所在的特定一組訂閱項目，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的訂閱識別碼清單作為參數，即可只擷取與指定訂閱中之保存庫相關聯的工作。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有訂閱中的記錄。 | 否 | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | 此參數可針對備份資料所在的特定一組區域，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的區域清單作為參數，即可只擷取與指定區域中之保存庫相關聯的工作。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有區域中的記錄。 | 否 | eastus,westus |
String |
| VaultList | 此參數可針對特定一組保存庫，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的保存庫名稱清單作為參數，即可只擷取指定保存庫相關的工作。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有保存庫中的工作。 | 否 | vault1,vault2,vault3 |
String |
| VaultTypeList | 此參數可用於篩選特定保存庫類型相關記錄的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋復原服務保存庫和備份保存庫。 | 否 | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | 此參數可用於選擇是否要查詢舊版 AzureDiagnostics 資料表中的資料。 若此參數的值為 false，函式會同時查詢 AzureDiagnostics 資料表和資源特定資料表中的資料。 若此參數的值為 true，此函式只會查詢資源特定資料表中的資料。 預設值為 True。 | 否 | true | 布林值 |
| BackupSolutionList | 此參數可針對您 Azure 環境中使用的特定一組備份解決方案，篩選函式查詢的輸出結果。 例如，若您指定 Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM 作為此參數的值，此函式回傳給 Azure 備份的記錄中，只會包含使用 Azure 虛擬機器備份、Azure VM 備份中的 SQL 或 DPM 所備份的項目。 根據預設，此參數的值為 ‘*'，表示函式會傳回備份報告所支援的所有備份解決方案相關記錄 (支援的值為 "Azure Virtual Machine Backup"、"SQL in Azure VM Backup"、"SAP HANA in Azure VM Backup"、"Azure Storage (Azure Files) Backup"、"Azure Backup Agent"、"DPM"、"Azure Backup Server"、"Azure Database for PostgreSQL Server Backup"、"Azure Blob Backup"，或以逗號分隔的前述任意值組合)。 |
否 | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| JobOperationList | 此參數可用於篩選特定類型工作的函式查詢輸出結果。 例如，備份或還原作業。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋備份及還原工作。 | 否 | "Backup" | String |
| JobStatusList | 此參數可用於篩選特定工作狀態的函式查詢輸出結果。 例如 Completed、Failed 等。 根據預設，此參數的值為 ‘*’，表示函式將不考慮狀態而搜尋所有工作。 | 否 | Failed,CompletedWithWarnings |
String |
| JobFailureCodeList | 此參數可用於篩選特定失敗碼的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將不考慮失敗碼而搜尋所有工作。 | 否 | "Success" | String |
| DatasourceSetName | 此參數可用於篩選特定父資源的函式查詢輸出結果。 例如，若要在隸屬於虛擬機器 "testvm" 之 Azure VM 備份執行個體中傳回 SQL，請將此參數的值指定為 testvm。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有備份執行個體中的記錄。 | 否 | "testvm" | String |
| BackupInstanceName | 使用此參數可依名稱搜尋特定備份執行個體上的工作。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有備份執行個體中的記錄。 | 否 | "testvm" | String |
| ExcludeLog | 此參數可用於排除記錄工作，函式便不會傳回此類工作 (有助於提升查詢效能)。 根據預設，此參數的值為 true，表示函式會排除記錄工作。 | 否 | true | 布林值 |
傳回的欄位
| 欄位名稱 | 說明 | **資料類型** |
|---|---|---|
| UniqueId | 代表工作專用識別碼的主索引鍵 | String |
| OperationCategory | 所要執行作業的類別。 例如備份或還原 | String |
| 作業 | 所要執行作業的詳細資料。 例如記錄 (記錄備份) | String |
| 狀態 | 工作的狀態。 例如 Completed、Failed、CompletedWithWarnings | String |
| ErrorTitle | 工作的失敗碼 | String |
| StartTime | 工作啟動的日期與時間 | Datetime |
| DurationInSecs | 工作的持續時間 (秒) | Double |
| DataTransferredInMBs | 工作傳送的資料 (MB)。 目前，只有復原服務保存庫工作負載才支援此欄位 | Double |
| RestoreJobRPDateTime | 建立所要復原之復原點的日期與時間。 目前，只有復原服務保存庫工作負載才支援此欄位 | Datetime |
| RestoreJobRPLocation | 所要復原之復原點的儲存位置 | String |
| BackupInstanceUniqueId | 此外部索引鍵會參考工作相關的備份執行個體 | String |
| BackupInstanceId | 工作相關備份執行個體的 Azure Resource Manager (ARM) 識別碼 | String |
| BackupInstanceFriendlyName | 工作相關備份執行個體的名稱 | String |
| DatasourceResourceId | 工作相關基礎資料來源的 Azure Resource Manager (ARM) 識別碼。 例如 VM 的 Azure Resource Manager (ARM) 識別碼 | String |
| DatasourceFriendlyName | 工作相關基礎資料來源的自訂名稱 | String |
| dataSourceType | 工作相關資料來源類型。 例如 "Microsoft.Compute/virtualMachines" | String |
| BackupSolution | 工作相關備份解決方案。 例如 Azure VM 備份、Azure VM 備份中的 SQL 等。 | String |
| DatasourceSetResourceId | 資料來源父資源 (如適用) 的 Azure Resource Manager (ARM) 識別碼。 以 Azure VM 資料來源中的 SQL 為例，此欄位會包含 SQL Database 所在 VM 的 Azure Resource Manager (ARM) 識別碼 | String |
| DatasourceSetType | 資料來源的父資源類型 (如其適用)。 以 Azure VM 資料來源中的 SAP Hana 為例，因為父資源為 Azure VM，此欄位會是 Microsoft. Compute/virtualMachines | String |
| VaultResourceId | 工作相關保存庫的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultUniqueId | 此外部索引鍵會參考工作相關的保存庫 | String |
| VaultName | 工作相關保存庫的名稱 | String |
| VaultTags | 工作相關保存庫的標籤 | String |
| VaultSubscriptionId | 工作相關保存庫的訂閱識別碼 | String |
| VaultLocation | 工作相關保存庫的位置 | String |
| VaultStore_StorageReplicationType | 原則相關保存庫的儲存體複寫類型 | String |
| VaultType | 保存庫類型，例如 “Microsoft.RecoveryServices/vaults” 或 “Microsoft.DataProtection/backupVaults” | String |
| TimeGenerated | 記錄的時間戳記 | Datetime |
_AzureBackup_GetBackupInstances()
此函式會傳回您復原服務保存庫相關的備份執行個體清單，以及每個備份執行個體的詳細資料，例如雲端儲存體取用量、相關的原則等。
參數
| 參數名稱 | 說明 | [必要？] | 範例值 | **資料類型** |
|---|---|---|---|---|
| RangeStart | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的備份執行個體相關記錄時，才需使用此參數搭配 RrangeEnd 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，表示函式只會擷取每個備份執行個體的最新記錄。 | 否 | "2021-03-03 00:00:00" | DataTime |
| RangeEnd | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有備份執行個體的相關記錄時，才需使用此參數搭配 RrangeStart 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，表示函式只會擷取每個備份執行個體的最新記錄。 | 否 | "2021-03-10 00:00:00" | Datetime |
| VaultSubscriptionList | 此參數可針對備份資料所在的特定一組訂閱項目，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的訂閱識別碼清單作為參數，即可只擷取指定訂閱中的備份執行個體。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有訂閱中的記錄。 | 否 | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | 此參數可針對備份資料所在的特定一組區域，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的區域清單作為參數，即可只擷取指定區域中的備份執行個體。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有區域中的記錄。 | 否 | eastus,westus |
String |
| VaultList | 此參數可針對特定一組保存庫，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的保存庫名稱清單作為參數，即可只擷取指定保存庫相關的備份執行個體記錄。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有保存庫的備份執行個體記錄。 | 否 | vault1,vault2,vault3 |
String |
| VaultTypeList | 此參數可用於篩選特定保存庫類型相關記錄的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋復原服務保存庫和備份保存庫。 | 否 | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | 此參數可用於選擇是否要查詢舊版 AzureDiagnostics 資料表中的資料。 若此參數的值為 false，函式會同時查詢 AzureDiagnostics 資料表和資源特定資料表中的資料。 若此參數的值為 true，此函式只會查詢資源特定資料表中的資料。 預設值為 True。 | 否 | true | 布林值 |
| BackupSolutionList | 此參數可針對您 Azure 環境中使用的特定一組備份解決方案，篩選函式查詢的輸出結果。 例如，若您指定 Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM 作為此參數的值，此函式回傳給 Azure 備份的記錄中，只會包含使用 Azure 虛擬機器備份、Azure VM 備份中的 SQL 或 DPM 所備份的項目。 根據預設，此參數的值為 ‘*'，表示函式會傳回備份報告所支援的所有備份解決方案相關記錄 (支援的值為 "Azure Virtual Machine Backup"、"SQL in Azure VM Backup"、"SAP HANA in Azure VM Backup"、"Azure Storage (Azure Files) Backup"、"Azure Backup Agent"、"DPM"、"Azure Backup Server"、"Azure Database for PostgreSQL Server Backup"、"Azure Blob Backup"，或以逗號分隔的前述任意值組合)。 |
否 | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| ProtectionInfoList | 使用此參數，即可選擇僅納入目前受保護的備份執行個體，還是也要納入已停止保護的執行個體及暫止初始備份的執行個體。 針對復原服務保存庫工作負載支援的值為 "Protected"、"ProtectionStopped"、"InitialBackupPending"，或以逗號分隔的前述任意值組合。 針對備份保存庫工作負載，支援的值為 “Protected”、“ConfiguringProtection”、“ConfiguringProtectionFailed”、“UpdateingProtection”、“ProtectionError”、“ProtectionStopped” 或其中任何值逗號分隔的組合。 根據預設，此值為 "*"，表示函式將不考慮保護詳細資料而搜尋所有備份執行個體。 | 否 | "Protected" | String |
| DatasourceSetName | 此參數可用於篩選特定父資源的函式查詢輸出結果。 例如，若要在隸屬於虛擬機器 "testvm" 之 Azure VM 備份執行個體中傳回 SQL，請將此參數的值指定為 testvm。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有備份執行個體中的記錄。 | 否 | "testvm" | String |
| BackupInstanceName | 使用此參數可依名稱搜尋特定備份執行個體。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有備份執行個體。 | 否 | "testvm" | String |
| DisplayAllFields | 此參數可用於選擇是否只要擷取函式傳回的欄位子集。 若此參數的值為 false，函式會從輸出結果中消除儲存體與保留點的相關資訊。 如果您使用此函式作為較大查詢中的中繼步驟，而且需要藉由排除您不需要分析的數據行來優化查詢的效能，這會很有用。 根據預設，此參數的值為 true，表示函式會傳回備份執行個體相關的所有欄位。 | 否 | true | 布林值 |
傳回的欄位
| 欄位名稱 | 說明 | 資料類型 |
|---|---|---|
| UniqueId | 代表備份執行個體專用識別碼的主索引鍵 | String |
| Id | 備份執行個體的 Azure Resource Manager (ARM) 識別碼 | String |
| FriendlyName | 備份執行個體的自訂名稱 | String |
| ProtectionInfo | 備份執行個體保護設定的相關資訊。 例如保護已設定、保護已停止、初始備份暫止 | String |
| LatestRecoveryPoint | 備份執行個體相關最新復原點的日期和時間。 目前，只有復原服務保存庫工作負載才支援此欄位。 | Datetime |
| OldestRecoveryPoint | 備份執行個體相關最舊復原點的日期和時間。 目前，只有復原服務保存庫工作負載才支援此欄位。 | Datetime |
| SourceSizeInMBs | 備份執行個體的前端大小 (MB) | Double |
| VaultStore_StorageConsumptionInMBs | 備份執行個體在保存庫標準層中取用的雲端儲存體總計 | Double |
| DataSourceFriendlyName | 備份執行個體對應資料來源的自訂名稱 | String |
| BackupSolution | 備份執行個體相關備份解決方案。 例如 Azure VM 備份、Azure VM 備份中的 SQL 等。 | String |
| dataSourceType | 備份執行個體對應資料來源的類型。 例如 "Microsoft.Compute/virtualMachines" | String |
| DatasourceResourceId | 備份執行個體對應基礎資料來源的 Azure Resource Manager (ARM) 識別碼。 例如 VM 的 Azure Resource Manager (ARM) 識別碼 | String |
| DatasourceSetFriendlyName | 資料來源父資源的自訂名稱 (如適用)。 以 Azure VM 中的 SQL 資料來源為例，此欄位會包含 SQL Database 所在 VM 的名稱 | String |
| DatasourceSetFriendlyName | 資料來源父資源的自訂名稱 (如適用)。 以 Azure VM 中的 SQL 資料來源為例，此欄位會包含 SQL Database 所在 VM 的名稱 | String |
| DatasourceSetResourceId | 資料來源父資源 (如適用) 的 Azure Resource Manager (ARM) 識別碼。 以 Azure VM 資料來源中的 SQL 為例，此欄位會包含 SQL Database 所在 VM 的 Azure Resource Manager (ARM) 識別碼 | String |
| DatasourceSetType | 資料來源的父資源類型 (如其適用)。 以 Azure VM 資料來源中的 SAP Hana 為例，因為父資源為 Azure VM，此欄位會是 Microsoft. Compute/virtualMachines | String |
| PolicyName | 備份執行個體相關原則的名稱 | String |
| PolicyUniqueId | 此外部索引鍵會參考備份執行個體相關的原則 | String |
| PolicyId | 備份執行個體相關原則的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultResourceId | 備份執行個體相關保存庫的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultUniqueId | 此外部索引鍵會參考備份執行個體相關的保存庫 | String |
| VaultName | 備份執行個體相關保存庫的名稱 | String |
| VaultTags | 備份執行個體相關保存庫的標籤 | String |
| VaultSubscriptionId | 備份執行個體相關保存庫的訂閱識別碼 | String |
| VaultLocation | 備份執行個體相關保存庫的位置 | String |
| VaultStore_StorageReplicationType | 備份執行個體相關保存庫的儲存體複寫類型 | String |
| VaultType | 保存庫類型為 “Microsoft.RecoveryServices/vaults” 或 “Microsoft.DataProtection/backupVaults” | String |
| TimeGenerated | 記錄的時間戳記 | Datetime |
_AzureBackup_GetBillingGroups()
此函式會傳回所有備份相關計費實體 (計費群組) 的清單，以及主要計費元件的相關資訊，例如前端大小和雲端儲存體總計。
參數
| 參數名稱 | 說明 | [必要？] | 範例值 | 日期類型 |
|---|---|---|---|---|
| RangeStart | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的計費群組相關記錄時，才需使用此參數搭配 RrangeEnd 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，表示函式只會擷取每個計費群組的最新記錄。 | 否 | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的計費群組相關記錄時，才需使用此參數搭配 RrangeStart 參數。 根據預設，RangeStart 和 RangeEnd 的值為 null，表示函式只會擷取每個計費群組的最新記錄。 | 否 | "2021-03-10 00:00:00" | Datetime |
| VaultSubscriptionList | 此參數可針對備份資料所在的特定一組訂閱項目，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的訂閱識別碼清單作為參數，即可只擷取指定訂閱中的計費群組。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有訂閱中的記錄。 | 否 | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | 此參數可針對備份資料所在的特定一組區域，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的區域清單作為參數，即可只擷取指定區域中的計費群組。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有區域中的記錄。 | 否 | eastus,westus |
String |
| VaultList | 此參數可針對特定一組保存庫，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的保存庫名稱清單作為參數，即可只擷取指定保存庫相關的備份執行個體記錄。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有保存庫中的計費群組記錄。 | 否 | vault1,vault2,vault3 |
String |
| VaultTypeList | 此參數可用於篩選特定保存庫類型相關記錄的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋復原服務保存庫和備份保存庫。 | 否 | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | 此參數可用於選擇是否要查詢舊版 AzureDiagnostics 資料表中的資料。 若此參數的值為 false，函式會同時查詢 AzureDiagnostics 資料表和資源特定資料表中的資料。 若此參數的值為 true，此函式只會查詢資源特定資料表中的資料。 預設值為 True。 | 否 | true | 布林值 |
| BackupSolutionList | 此參數可針對您 Azure 環境中使用的特定一組備份解決方案，篩選函式查詢的輸出結果。 例如，若您指定 Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM 作為此參數的值，此函式回傳給 Azure 備份的記錄中，只會包含使用 Azure 虛擬機器備份、Azure VM 備份中的 SQL 或 DPM 所備份的項目。 根據預設，此參數的值為 ‘*'，表示函式會傳回備份報告所支援的所有備份解決方案相關記錄 (支援的值為 "Azure Virtual Machine Backup"、"SQL in Azure VM Backup"、"SAP HANA in Azure VM Backup"、"Azure Storage (Azure Files) Backup"、"Azure Backup Agent"、"DPM"、"Azure Backup Server"、"Azure Database for PostgreSQL Server Backup"、"Azure Blob Backup"，或以逗號分隔的前述任意值組合)。 |
否 | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| BillingGroupName | 使用此參數可依名稱搜尋特定的計費群組。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有計費群組。 | 否 | "testvm" | String |
傳回的欄位
| 欄位名稱 | 說明 | 資料類型 |
|---|---|---|
| UniqueId | 代表計費群組專用識別碼的主索引鍵 | String |
| FriendlyName | 計費群組的自訂名稱 | String |
| 名稱 | 計費群組的名稱 | String |
| 類型 | 計費群組的類型。 例如 ProtectedContainer 或 BackupItem | String |
| SourceSizeInMBs | 計費群組的前端大小 (MB) | Double |
| VaultStore_StorageConsumptionInMBs | 計費群組在保存庫標準層中取用的雲端儲存體總計 | Double |
| BackupSolution | 計費群組相關的備份解決方案。 例如 Azure VM 備份、Azure VM 備份中的 SQL 等。 | String |
| VaultResourceId | 計費群組相關保存庫的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultUniqueId | 此外部索引鍵會參考計費群組相關的保存庫 | String |
| VaultName | 計費群組相關保存庫的名稱 | String |
| VaultTags | 計費群組相關保存庫的標籤 | String |
| VaultSubscriptionId | 計費群組相關保存庫的訂閱識別碼 | String |
| VaultLocation | 計費群組相關保存庫的位置 | String |
| VaultStore_StorageReplicationType | 計費群組相關保存庫的儲存體複寫類型 | String |
| VaultType | 保存庫類型，例如 “Microsoft.RecoveryServices/vaults” 或 “Microsoft.DataProtection/backupVaults” | String |
| TimeGenerated | 記錄的時間戳記 | Datetime |
| ExtendedProperties | 計費群組的其他屬性 | 動態 |
趨勢函數
_AzureBackup_GetBackupInstancesTrends()
此函式會傳回每個備份執行個體的歷程記錄，如此可使用不同的細微性層級，檢視備份執行個體計數與儲存體取用量的每日、每週和每月趨勢。
參數
| 參數名稱 | 說明 | [必要？] | 範例值 | 資料類型 |
|---|---|---|---|---|
| RangeStart | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的備份執行個體相關記錄時，才需使用此參數搭配 RrangeEnd 參數。 | Y | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的備份執行個體相關記錄時，才需使用此參數搭配 RrangeStart 參數。 | Y | "2021-03-10 00:00:00" | Datetime |
| VaultSubscriptionList | 此參數可針對備份資料所在的特定一組訂閱項目，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的訂閱識別碼清單作為參數，即可只擷取指定訂閱中的備份執行個體。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有訂閱中的記錄。 | 否 | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | 此參數可針對備份資料所在的特定一組區域，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的區域清單作為參數，即可只擷取指定區域中的備份執行個體。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有區域中的記錄。 | 否 | eastus,westus |
String |
| VaultList | 此參數可針對特定一組保存庫，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的保存庫名稱清單作為參數，即可只擷取指定保存庫相關的備份執行個體記錄。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有保存庫的備份執行個體記錄。 | 否 | vault1,vault2,vault3 |
String |
| VaultTypeList | 此參數可用於篩選特定保存庫類型相關記錄的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋復原服務保存庫和備份保存庫。 | 否 | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | 此參數可用於選擇是否要查詢舊版 AzureDiagnostics 資料表中的資料。 若此參數的值為 false，函式會同時查詢 AzureDiagnostics 資料表和資源特定資料表中的資料。 若此參數的值為 true，此函式只會查詢資源特定資料表中的資料。 預設值為 True。 | 否 | true | 布林值 |
| BackupSolutionList | 此參數可針對您 Azure 環境中使用的特定一組備份解決方案，篩選函式查詢的輸出結果。 例如，若您指定 Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM 作為此參數的值，此函式回傳給 Azure 備份的記錄中，只會包含使用 Azure 虛擬機器備份、Azure VM 備份中的 SQL 或 DPM 所備份的項目。 根據預設，此參數的值為 ‘*'，表示函式會傳回備份報告所支援的所有備份解決方案相關記錄 (支援的值為 "Azure Virtual Machine Backup"、"SQL in Azure VM Backup"、"SAP HANA in Azure VM Backup"、"Azure Storage (Azure Files) Backup"、"Azure Backup Agent"、"DPM"、"Azure Backup Server"、"Azure Database for PostgreSQL Server Backup"、"Azure Blob Backup"，或以逗號分隔的前述任意值組合)。 |
否 | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| ProtectionInfoList | 使用此參數，即可選擇僅納入目前受保護的備份執行個體，還是也要納入已停止保護的執行個體及暫止初始備份的執行個體。 針對復原服務保存庫工作負載支援的值為 "Protected"、"ProtectionStopped"、"InitialBackupPending"，或以逗號分隔的前述任意值組合。 針對備份保存庫工作負載，支援的值為 “Protected”、“ConfiguringProtection”、“ConfiguringProtectionFailed”、“UpdateingProtection”、“ProtectionError”、“ProtectionStopped” 或其中任何值逗號分隔的組合。 根據預設，此值為 "*"，表示函式將不考慮保護詳細資料而搜尋所有備份執行個體。 | 否 | "Protected" | String |
| DatasourceSetName | 此參數可用於篩選特定父資源的函式查詢輸出結果。 例如，若要在隸屬於虛擬機器 "testvm" 之 Azure VM 備份執行個體中傳回 SQL，請將此參數的值指定為 testvm。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有備份執行個體中的記錄。 | 否 | "testvm" | String |
| BackupInstanceName | 使用此參數可依名稱搜尋特定備份執行個體。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有備份執行個體。 | 否 | "testvm" | String |
| DisplayAllFields | 此參數可用於選擇是否只要擷取函式傳回的欄位子集。 若此參數的值為 false，函式會從輸出結果中消除儲存體與保留點的相關資訊。 如果您使用此函式作為較大查詢中的中繼步驟，而且需要藉由排除您不需要分析的數據行來優化查詢的效能，這會很有用。 根據預設，此參數的值為 true，表示函式會傳回備份執行個體相關的所有欄位。 | 否 | true | 布林值 |
| AggregationType | 此參數可用於指定擷取資料時所要使用的時間細微性。 若此參數的值為 "Daily"，函式將會每天傳回每個備份執行個體的記錄，讓您分析儲存體取用量和備份執行個體計數的趨勢。 若此參數的值為 "Weekly"，函式將會每週傳回每個備份執行個體的記錄，讓您分析每週趨勢。 同樣地，您可以指定 “Monthly” 來分析每月趨勢。 預設值為 “Daily”。 如果您要在較大的時間範圍內檢視數據，建議您使用「每周」或「每月」，以提升查詢效能並輕鬆分析趨勢。 | 否 | "Weekly" | String |
傳回的欄位
| 欄位名稱 | 說明 | 資料類型 |
|---|---|---|
| UniqueId | 代表備份執行個體專用識別碼的主索引鍵 | String |
| Id | 備份執行個體的 Azure Resource Manager (ARM) 識別碼 | String |
| FriendlyName | 備份執行個體的自訂名稱 | String |
| ProtectionInfo | 備份執行個體保護設定的相關資訊。 例如保護已設定、保護已停止、初始備份暫止 | String |
| LatestRecoveryPoint | 備份執行個體相關最新復原點的日期和時間。 目前，只有復原服務保存庫工作負載才支援此欄位 | Datetime |
| OldestRecoveryPoint | 備份執行個體相關最舊復原點的日期和時間 | 目前，只有復原服務保存庫工作負載才支援此欄位 |
| SourceSizeInMBs | 備份執行個體的前端大小 (MB) | Double |
| VaultStore_StorageConsumptionInMBs | 備份執行個體在保存庫標準層中取用的雲端儲存體總計 | Double |
| DataSourceFriendlyName | 備份執行個體對應資料來源的自訂名稱 | String |
| BackupSolution | 備份執行個體相關備份解決方案。 例如 Azure VM 備份、Azure VM 備份中的 SQL 等。 | String |
| dataSourceType | 備份執行個體對應資料來源的類型。 例如 "Microsoft.Compute/virtualMachines" | String |
| DatasourceResourceId | 備份執行個體對應基礎資料來源的 Azure Resource Manager (ARM) 識別碼。 例如 VM 的 Azure Resource Manager (ARM) 識別碼 | String |
| DatasourceSetFriendlyName | 資料來源父資源的自訂名稱 (如適用)。 以 Azure VM 中的 SQL 資料來源為例，此欄位會包含 SQL Database 所在 VM 的名稱 | String |
| DatasourceSetResourceId | 資料來源父資源 (如適用) 的 Azure Resource Manager (ARM) 識別碼。 以 Azure VM 資料來源中的 SQL 為例，此欄位會包含 SQL Database 所在 VM 的 Azure Resource Manager (ARM) 識別碼 | String |
| DatasourceSetType | 資料來源的父資源類型 (如其適用)。 以 Azure VM 資料來源中的 SAP Hana 為例，因為父資源為 Azure VM，此欄位會是 Microsoft. Compute/virtualMachines | String |
| PolicyName | 備份執行個體相關原則的名稱 | String |
| PolicyUniqueId | 此外部索引鍵會參考備份執行個體相關的原則 | String |
| PolicyId | 備份執行個體相關原則的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultResourceId | 備份執行個體相關保存庫的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultUniqueId | 此外部索引鍵會參考備份執行個體相關的保存庫 | String |
| VaultName | 備份執行個體相關保存庫的名稱 | String |
| VaultTags | 備份執行個體相關保存庫的標籤 | String |
| VaultSubscriptionId | 備份執行個體相關保存庫的訂閱識別碼 | String |
| VaultLocation | 備份執行個體相關保存庫的位置 | String |
| VaultStore_StorageReplicationType | 備份執行個體相關保存庫的儲存體複寫類型 | String |
| VaultType | 保存庫類型，例如 “Microsoft.RecoveryServices/vaults” 或 “Microsoft.DataProtection/backupVaults” | String |
| TimeGenerated | 記錄的時間戳記 | Datetime |
_AzureBackup_GetBillingGroupsTrends()
此函式會傳回每個計費群組的歷程記錄，如此可使用不同的細微性層級，檢視備份執行個體計數與儲存體取用量的每日、每週和每月趨勢。
參數
| 參數名稱 | 說明 | [必要？] | 範例值 | 資料類型 |
|---|---|---|---|---|
| RangeStart | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的計費群組相關記錄時，才需使用此參數搭配 RrangeEnd 參數。 | Y | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | 僅在需要擷取從 RangeStart 到 RangeEnd 期間內所有的計費群組相關記錄時，才需使用此參數搭配 RrangeStart 參數。 | Y | "2021-03-10 00:00:00" | Datetime |
| VaultSubscriptionList | 此參數可針對備份資料所在的特定一組訂閱項目，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的訂閱識別碼清單作為參數，即可只擷取指定訂閱中的計費群組。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有訂閱中的記錄。 | 否 | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | 此參數可針對備份資料所在的特定一組區域，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的區域清單作為參數，即可只擷取指定區域中的計費群組。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有區域中的記錄。 | 否 | eastus,westus |
String |
| VaultList | 此參數可針對特定一組保存庫，篩選函式查詢的輸出結果。 在此函式中指定以逗號分隔的保存庫名稱清單作為參數，即可只擷取指定保存庫相關的備份執行個體記錄。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有保存庫中的計費群組記錄。 | 否 | vault1,vault2,vault3 |
String |
| VaultTypeList | 此參數可用於篩選特定保存庫類型相關記錄的函式查詢輸出結果。 根據預設，此參數的值為 ‘*’，表示函式將同時搜尋復原服務保存庫和備份保存庫。 | 否 | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | 此參數可用於選擇是否要查詢舊版 AzureDiagnostics 資料表中的資料。 若此參數的值為 false，函式會同時查詢 AzureDiagnostics 資料表和資源特定資料表中的資料。 若此參數的值為 true，此函式只會查詢資源特定資料表中的資料。 預設值為 True。 | 否 | true | 布林值 |
| BackupSolutionList | 此參數可針對您 Azure 環境中使用的特定一組備份解決方案，篩選函式查詢的輸出結果。 例如，若您指定 Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM 作為此參數的值，此函式回傳給 Azure 備份的記錄中，只會包含使用 Azure 虛擬機器備份、Azure VM 備份中的 SQL 或 DPM 所備份的項目。 根據預設，此參數的值為 ‘*'，表示函式會傳回備份報告所支援的所有備份解決方案相關記錄 (支援的值為 "Azure Virtual Machine Backup"、"SQL in Azure VM Backup"、"SAP HANA in Azure VM Backup"、"Azure Storage (Azure Files) Backup"、"Azure Backup Agent"、"DPM"、"Azure Backup Server"、"Azure Database for PostgreSQL Server Backup"、"Azure Blob Backup"，或以逗號分隔的前述任意值組合)。 |
否 | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| BillingGroupName | 使用此參數可依名稱搜尋特定的計費群組。 根據預設，此參數的值為 ‘*’，表示函式將搜尋所有計費群組。 | 否 | "testvm" | String |
| AggregationType | 此參數可用於指定擷取資料時所要使用的時間細微性。 若此參數的值為 "Daily"，函式將會每天傳回每個計費群組的記錄，讓您分析儲存體取用量和前端大小的每日趨勢。 若此參數的值為 "Weekly"，函式將會每週傳回每個備份執行個體的記錄，讓您分析每週趨勢。 同樣地，您可以指定 “Monthly” 來分析每月趨勢。 預設值為 “Daily”。 如果您要在較大的時間範圍內檢視數據，建議您使用「每周」或「每月」，以提升查詢效能並輕鬆分析趨勢。 | 否 | "Weekly" | String |
傳回的欄位
| 欄位名稱 | 說明 | 資料類型 |
|---|---|---|
| UniqueId | 代表計費群組專用識別碼的主索引鍵 | String |
| FriendlyName | 計費群組的自訂名稱 | String |
| 名稱 | 計費群組的名稱 | String |
| 類型 | 計費群組的類型。 例如 ProtectedContainer 或 BackupItem | String |
| SourceSizeInMBs | 計費群組的前端大小 (MB) | Double |
| VaultStore_StorageConsumptionInMBs | 計費群組在保存庫標準層中取用的雲端儲存體總計 | Double |
| BackupSolution | 計費群組相關的備份解決方案。 例如 Azure VM 備份、Azure VM 備份中的 SQL 等。 | String |
| VaultResourceId | 計費群組相關保存庫的 Azure Resource Manager (ARM) 識別碼 | String |
| VaultUniqueId | 此外部索引鍵會參考計費群組相關的保存庫 | String |
| VaultName | 計費群組相關保存庫的名稱 | String |
| VaultTags | 計費群組相關保存庫的標籤 | String |
| VaultSubscriptionId | 計費群組相關保存庫的訂閱識別碼 | String |
| VaultLocation | 計費群組相關保存庫的位置 | String |
| VaultStore_StorageReplicationType | 計費群組相關保存庫的儲存體複寫類型 | String |
| VaultType | 保存庫類型，例如 “Microsoft.RecoveryServices/vaults” 或 “Microsoft.DataProtection/backupVaults” | String |
| TimeGenerated | 記錄的時間戳記 | Datetime |
| ExtendedProperties | 計費群組的其他屬性 | 動態 |
範例查詢
下列查詢範例可協助您開始使用系統函式。
指定時間範圍內所有失敗的 Azure VM 備份工作
_AzureBackup_GetJobs("2021-03-05", "2021-03-06") //call function with RangeStart and RangeEnd parameters set, and other parameters with default value | where BackupSolution=="Azure Virtual Machine Backup" and Status=="Failed" | project BackupInstanceFriendlyName, BackupInstanceId, OperationCategory, Status, JobStartDateTime=StartTime, JobDuration=DurationInSecs/3600, ErrorTitle, DataTransferred=DataTransferredInMBs指定時間範圍內所有的 SQL 記錄備份工作
_AzureBackup_GetJobs("2021-03-05", "2021-03-06","*","*","*","*",true,"*","*","*","*","*","*",false) //call function with RangeStart and RangeEnd parameters set, ExcludeLog parameter as false, and other parameters with default value | where BackupSolution=="SQL in Azure VM Backup" and Operation=="Log" | project BackupInstanceFriendlyName, BackupInstanceId, OperationCategory, Status, JobStartDateTime=StartTime, JobDuration=DurationInSecs/3600, ErrorTitle, DataTransferred=DataTransferredInMBsVM "testvm" 備份儲存體取用量的每週趨勢
_AzureBackup_GetBackupInstancesTrends("2021-01-01", "2021-03-06","*","*","*","*",false,"*","*","*","*",true, "Weekly") //call function with RangeStart and RangeEnd parameters set, AggregationType parameter as Weekly, and other parameters with default value | where BackupSolution == "Azure Virtual Machine Backup" | where FriendlyName == "testvm" | project TimeGenerated, VaultStore_StorageConsumptionInMBs | render timechart