Backup Protectable Items - List

リファレンス

サービス:: Recovery Services - Backup

API バージョン:: 2024-10-01

クエリフィルターと改ページパラメーターに従って、サブスクリプション内の保護可能なオブジェクトのページング可能な一覧を提供します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems?api-version=2024-10-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems?api-version=2024-10-01&$filter={$filter}&$skipToken={$skipToken}

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	Recovery Services コンテナーが存在するリソースグループの名前。
subscriptionId	path	True	string	サブスクリプション ID。
vaultName	path	True	string	Recovery Services コンテナーの名前。
api-version	query	True	string	クライアント API のバージョン。
$filter	query		string	OData フィルターオプション。
$skipToken	query		string	skipToken フィルター。

応答

名前	型	説明
200 OK	WorkloadProtectableItemResourceList	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装します。

例

List protectable items with backupManagementType filter as AzureIaasVm

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupProtectableItems?api-version=2024-10-01&$filter=backupManagementType eq 'AzureIaasVM'

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectableItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
      "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
      "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectableItems",
      "properties": {
        "friendlyName": "iaasvm-1",
        "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1",
        "protectionState": "NotProtected",
        "protectableItemType": "Microsoft.ClassicCompute/virtualMachines",
        "backupManagementType": "AzureIaasVM",
        "workloadType": "VM"
      }
    }
  ]
}

定義

名前	説明
AzureFileShareProtectableItem	Azure Fileshare ワークロードの保護可能な項目。
AzureFileShareType	ファイル共有の種類は XSync または XSMB です。
AzureIaaSClassicComputeVMProtectableItem	クラシックコンピューティング VM を表す IaaS VM ワークロード固有のバックアップ項目。
AzureIaaSComputeVMProtectableItem	Azure Resource Manager VM を表す IaaS VM ワークロード固有のバックアップ項目。
AzureVmWorkloadProtectableItem	Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSAPAseSystemProtectableItem	SAP ASE システムを表す Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSAPHanaDatabaseProtectableItem	SAP HANA データベースを表す Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSAPHanaDBInstance	SAP HANA Dbinstance を表す Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSAPHanaHSRProtectableItem	HANA HSR を表す Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSAPHanaSystemProtectableItem	SAP HANA システムを表す Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSQLAvailabilityGroupProtectableItem	SQL 可用性グループを表す Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSQLDatabaseProtectableItem	SQL Database を表す Azure VM ワークロード固有の保護可能な項目。
AzureVmWorkloadSQLInstanceProtectableItem	SQL インスタンスを表す Azure VM ワークロード固有の保護可能な項目。
CloudError	コンテナーインスタンスサービスからのエラー応答。
CloudErrorBody	コンテナーインスタンスサービスからのエラー応答。
DistributedNodesInfo	これは、分散コンテナーのさまざまなノードを表すために使用されます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	コード、メッセージ、および推奨事項をカプセル化する Error Detail クラス。
IaaSVMProtectableItem	IaaS VM ワークロード固有のバックアップ項目。
InquiryStatus	保護可能な項目の状態 (つまり、InProgress、Succeeded、Failed)
PreBackupValidation	Azure VM ワークロードプロバイダーのバックアップ前検証。
ProtectionStatus	バックアップ項目の状態。
WorkloadProtectableItemResource	バックアップ項目の基本クラス。ワークロード固有のバックアップ項目は、このクラスから派生します。
WorkloadProtectableItemResourceList	WorkloadProtectableItem リソースの一覧

AzureFileShareProtectableItem

Azure Fileshare ワークロードの保護可能な項目。

名前	型	説明
azureFileShareType	AzureFileShareType	ファイル共有の種類は XSync または XSMB です。
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
parentContainerFabricId	string	この保護可能な項目が属するコンテナーの完全なファブリック ID。たとえば、ARM ID です。
parentContainerFriendlyName	string	この保護可能な項目が属するコンテナーのフレンドリ名。
protectableItemType	string: AzureFileShare	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
workloadType	string	バックアップ管理のワークロードの種類

AzureFileShareType

ファイル共有の種類は XSync または XSMB です。

名前	型	説明
Invalid	string
XSMB	string
XSync	string

AzureIaaSClassicComputeVMProtectableItem

クラシックコンピューティング VM を表す IaaS VM ワークロード固有のバックアップ項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
protectableItemType	string: Microsoft.ClassicCompute/virtualMachines	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
resourceGroup	string	Recovery Services コンテナーのリソースグループ名。
virtualMachineId	string	仮想マシンの完全修飾 ARM ID。
virtualMachineVersion	string	コンテナーがクラシック VM と Azure Resource Manager VM のどちらを表すかを指定します。
workloadType	string	バックアップ管理のワークロードの種類

AzureIaaSComputeVMProtectableItem

Azure Resource Manager VM を表す IaaS VM ワークロード固有のバックアップ項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
protectableItemType	string: Microsoft.Compute/virtualMachines	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
resourceGroup	string	Recovery Services コンテナーのリソースグループ名。
virtualMachineId	string	仮想マシンの完全修飾 ARM ID。
virtualMachineVersion	string	コンテナーがクラシック VM と Azure Resource Manager VM のどちらを表すかを指定します。
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadProtectableItem

Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: AzureVmWorkloadProtectableItem	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSAPAseSystemProtectableItem

SAP ASE システムを表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: SAPAseSystem	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSAPHanaDatabaseProtectableItem

SAP HANA データベースを表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: SAPHanaDatabase	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSAPHanaDBInstance

SAP HANA Dbinstance を表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: SAPHanaDBInstance	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSAPHanaHSRProtectableItem

HANA HSR を表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: HanaHSRContainer	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSAPHanaSystemProtectableItem

SAP HANA システムを表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: SAPHanaSystem	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

SQL 可用性グループを表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
nodesList	DistributedNodesInfo[]	分散コンテナーの場合のノードの一覧。
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: SQLAvailabilityGroupContainer	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSQLDatabaseProtectableItem

SQL Database を表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: SQLDataBase	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

AzureVmWorkloadSQLInstanceProtectableItem

SQL インスタンスを表す Azure VM ワークロード固有の保護可能な項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
isAutoProtectable	boolean	保護可能な項目が自動保護可能かどうかを示します
isAutoProtected	boolean	保護可能な項目が自動保護されているかどうかを示します
isProtectable	boolean	項目が保護可能かどうかを示します
parentName	string	インスタンスまたは AG の名前
parentUniqueName	string	親の一意の名前が追加され、親がインスタンスまたは SQL AG のいずれかのデータベースに適用できる親のみのサービス形式の URI 名が提供されます。
prebackupvalidation	PreBackupValidation	保護可能なオブジェクトのバックアップ前検証
protectableItemType	string: SQLInstance	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
serverName	string	インスタンスまたは AG のホスト/クラスター名
subinquireditemcount	integer	たとえば、AG の場合は、DB の存在する数を示します
subprotectableitemcount	integer	たとえば、AG は、保護する DB の数を示します
workloadType	string	バックアップ管理のワークロードの種類

CloudError

コンテナーインスタンスサービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラーオブジェクト。

CloudErrorBody

コンテナーインスタンスサービスからのエラー応答。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

DistributedNodesInfo

これは、分散コンテナーのさまざまなノードを表すために使用されます。

名前	型	説明
errorDetail	ErrorDetail	状態が成功以外の場合のエラーの詳細。
nodeName	string	分散コンテナーの下のノードの名前。
sourceResourceId	string	ノードの ARM リソース ID
status	string	このノードの状態。失敗 \|成功

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

コード、メッセージ、および推奨事項をカプセル化する Error Detail クラス。

名前	型	説明
code	string	エラーコード。
message	string	コードに関連するエラーメッセージ。
recommendations	string[]	推奨文字列の一覧。

IaaSVMProtectableItem

IaaS VM ワークロード固有のバックアップ項目。

名前	型	説明
backupManagementType	string	項目をバックアップするバックアップ管理の種類。
friendlyName	string	バックアップ項目のフレンドリ名。
protectableItemType	string: IaaSVMProtectableItem	バックアップ項目の種類。
protectionState	ProtectionStatus	バックアップ項目の状態。
resourceGroup	string	Recovery Services コンテナーのリソースグループ名。
virtualMachineId	string	仮想マシンの完全修飾 ARM ID。
virtualMachineVersion	string	コンテナーがクラシック VM と Azure Resource Manager VM のどちらを表すかを指定します。
workloadType	string	バックアップ管理のワークロードの種類

InquiryStatus

保護可能な項目の状態 (つまり、InProgress、Succeeded、Failed)

名前	型	説明
Failed	string
Invalid	string
Success	string

PreBackupValidation

Azure VM ワークロードプロバイダーのバックアップ前検証。

名前	型	説明
code	string	保護可能な項目のエラーコード
message	string	保護可能な項目のエラーコードに対応するメッセージ
status	InquiryStatus	保護可能な項目の状態 (つまり、InProgress、Succeeded、Failed)

ProtectionStatus

バックアップ項目の状態。

名前	型	説明
Invalid	string
NotProtected	string
Protected	string
Protecting	string
ProtectionFailed	string

WorkloadProtectableItemResource

バックアップ項目の基本クラス。ワークロード固有のバックアップ項目は、このクラスから派生します。

名前	型	説明
eTag	string	省略可能な ETag。
id	string	リソース ID は、リソースへの完全なパスを表します。
location	string	リソースの場所。
name	string	リソースに関連付けられているリソース名。
properties	WorkloadProtectableItem: AzureFileShareProtectableItem AzureIaaSClassicComputeVMProtectableItem AzureIaaSComputeVMProtectableItem AzureVmWorkloadProtectableItem AzureVmWorkloadSAPAseSystemProtectableItem AzureVmWorkloadSAPHanaDBInstance AzureVmWorkloadSAPHanaDatabaseProtectableItem AzureVmWorkloadSAPHanaHSRProtectableItem AzureVmWorkloadSAPHanaSystemProtectableItem AzureVmWorkloadSQLAvailabilityGroupProtectableItem AzureVmWorkloadSQLDatabaseProtectableItem AzureVmWorkloadSQLInstanceProtectableItem IaaSVMProtectableItem	WorkloadProtectableItemResource プロパティ
tags	object	リソースタグ。
type	string	リソースの種類は、Namespace/ResourceType/ResourceType/..フォームの完全なパスを表します。

WorkloadProtectableItemResourceList

WorkloadProtectableItem リソースの一覧

名前	型	説明
nextLink	string	リソースの次のページをフェッチする URI。 ListNext() を呼び出すと、リソースの次のページがフェッチされます。
value	WorkloadProtectableItemResource[]	リソースの一覧。

次の方法で共有