Backup-AzureRmApiManagement
API Management サービスをバックアップします。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Backup-AzureRmApiManagement
-ResourceGroupName <String>
-Name <String>
-StorageContext <IStorageContext>
-TargetContainerName <String>
[-TargetBlobName <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Backup-AzureRmApiManagement コマンドレットは、Azure API Management サービスのインスタンスをバックアップします。 このコマンドレットは、バックアップを Azure Storage BLOB として格納します。
例
例 1: API Management サービスをバックアップする
PS C:\>New-AzureRmStorageAccount -StorageAccountName "ContosoStorage" -Location $location -ResourceGroupName "ContosoGroup02" -Type Standard_LRS
PS C:\>$storageKey = (Get-AzureRmStorageAccountKey -ResourceGroupName "ContosoGroup02" -StorageAccountName "ContosoStorage")[0].Value
PS C:\>$storageContext = New-AzureStorageContext -StorageAccountName "ContosoStorage" -StorageAccountKey $storageKey
PS C:\>Backup-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -StorageContext $StorageContext -TargetContainerName "ContosoBackups" -TargetBlobName "ContosoBackup.apimbackup"
このコマンドは、API Management サービスをストレージ BLOB にバックアップします。
パラメーター
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
このコマンドレットがバックアップする API Management デプロイの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PassThru
操作が成功した場合、このコマンドレットによってバックアップ された PsApiManagement オブジェクトが返されることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
API Management デプロイが存在するリソース グループの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-StorageContext
ストレージ接続コンテキストを指定します。
型: | IStorageContext |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TargetBlobName
バックアップの BLOB の名前を指定します。 BLOB が存在しない場合は、このコマンドレットによって作成されます。 このコマンドレットは、{Name}-{yyyy-MM-dd-HH-mm}.apimbackup というパターンに基づいて既定値を生成します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TargetContainerName
バックアップの BLOB のコンテナーの名前を指定します。 コンテナーが存在しない場合は、このコマンドレットによって作成されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |