Suspend-AzDataProtectionBackupInstanceBackup

この操作により、バックアップ インスタンスのバックアップが停止され、ポリシーに従ってバックアップ データが保持されます (最新の復旧ポイントを除き、永続的に保持されます)。

構文

Suspend (既定)

Suspend-AzDataProtectionBackupInstanceBackup
    -BackupInstanceName <String>
    -ResourceGroupName <String>
    -VaultName <String>
    [-SubscriptionId <String>]
    [-Token <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-ResourceGuardOperationRequest <String[]>]
    [-SecureToken <SecureString>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SuspendViaJsonString

Suspend-AzDataProtectionBackupInstanceBackup
    -BackupInstanceName <String>
    -ResourceGroupName <String>
    -VaultName <String>
    -JsonString <String>
    [-SubscriptionId <String>]
    [-Token <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SuspendViaJsonFilePath

Suspend-AzDataProtectionBackupInstanceBackup
    -BackupInstanceName <String>
    -ResourceGroupName <String>
    -VaultName <String>
    -JsonFilePath <String>
    [-SubscriptionId <String>]
    [-Token <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SuspendViaIdentityBackupVaultExpanded

Suspend-AzDataProtectionBackupInstanceBackup
    -BackupInstanceName <String>
    -BackupVaultInputObject <IDataProtectionIdentity>
    [-Token <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-ResourceGuardOperationRequest <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SuspendViaIdentityBackupVault

Suspend-AzDataProtectionBackupInstanceBackup
    -BackupInstanceName <String>
    -BackupVaultInputObject <IDataProtectionIdentity>
    -Parameter <ISuspendBackupRequest>
    [-Token <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SuspendViaIdentity

Suspend-AzDataProtectionBackupInstanceBackup
    -InputObject <IDataProtectionIdentity>
    [-Token <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-ResourceGuardOperationRequest <String[]>]
    [-SecureToken <SecureString>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

この操作により、バックアップ インスタンスのバックアップが停止され、ポリシーに従ってバックアップ データが保持されます (最新の復旧ポイントを除き、永続的に保持されます)。

例

例 1: バックアップ インスタンスのバックアップを中断する

Suspend-AzDataProtectionBackupInstanceBackup -ResourceGroupName "rgName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -BackupInstanceName $backupInstance.BackupInstanceName

上記のコマンドを使用してバックアップ インスタンスのバックアップを停止できます。これにより、バックアップ インスタンスが中断状態に移動します。

パラメーター

-AsJob

コマンドをジョブとして実行する

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-BackupInstanceName

バックアップ インスタンスの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Suspend
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonString
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonFilePath
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaIdentityBackupVaultExpanded
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaIdentityBackupVault
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-BackupVaultInputObject

IDENTITY パラメーター

パラメーターのプロパティ

型:IDataProtectionIdentity
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SuspendViaIdentityBackupVaultExpanded
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaIdentityBackupVault
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:Cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

パラメーターのプロパティ

型:PSObject
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:AzureRMContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

パラメーターのプロパティ

型:IDataProtectionIdentity
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SuspendViaIdentity
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-JsonFilePath

Suspend 操作に指定された Json ファイルのパス

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SuspendViaJsonFilePath
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-JsonString

Suspend 操作に指定された Json 文字列

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SuspendViaJsonString
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-NoWait

コマンドを非同期的に実行する

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Parameter

MUA が有効になっているときにバックアップを中断する要求本文

パラメーターのプロパティ

型:ISuspendBackupRequest
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SuspendViaIdentityBackupVault
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PassThru

コマンドが成功したときに true を返します。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceGroupName

リソース グループの名前。 名前は大文字と小文字を区別しません。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Suspend
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonString
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonFilePath
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceGuardOperationRequest

Resource guard 操作要求は、 <ResourceGuard-ARMID>/dppDisableSuspendBackupsRequests/default のような形式です。 操作が MUA で保護されている場合は、このパラメーターを使用します。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Suspend
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaIdentityBackupVaultExpanded
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaIdentity
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SecureToken

テナント間リソース ガードによって保護される操作を承認するためのパラメーター。 コマンド (Get-AzAccessToken -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -AsSecureString" を使用します)。異なるテナントの承認トークンをフェッチするトークン。

パラメーターのプロパティ

型:SecureString
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Suspend
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaIdentity
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SubscriptionId

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

パラメーターのプロパティ

型:String
規定値:(Get-AzContext).Subscription.Id
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Suspend
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonString
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonFilePath
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Token

パラメーターは非推奨です。 代わりに SecureToken を使用してください。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-VaultName

バックアップ ボールトの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Suspend
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonString
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SuspendViaJsonFilePath
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:wi

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

IDataProtectionIdentity

ISuspendBackupRequest

出力

Boolean