Update-AzDataBoxJob

リファレンス

モジュール:: Az.DataBox

既存のジョブのプロパティを更新します。

構文

Update-AzDataBoxJob
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-IfMatch <String>]
      [-ContactDetail <IContactDetails>]
      [-ContactDetailContactName <String>]
      [-ContactDetailMobile <String>]
      [-ContactDetailPhone <String>]
      [-ContactDetailPhoneExtension <String>]
      [-EncryptionPreferenceDoubleEncryption <DoubleEncryption>]
      [-EncryptionPreferenceHardwareEncryption <HardwareEncryption>]
      [-IdentityType <String>]
      [-KeyEncryptionKey <IKeyEncryptionKey>]
      [-PreferencePreferredDataCenterRegion <String[]>]
      [-ReturnToCustomerPackageDetailCarrierAccountNumber <String>]
      [-ReturnToCustomerPackageDetailCarrierName <String>]
      [-ReturnToCustomerPackageDetailTrackingId <String>]
      [-ReverseShippingDetail <IShippingAddress>]
      [-ReverseTransportPreferredShipmentType <TransportShipmentTypes>]
      [-ShippingAddress <IShippingAddress>]
      [-StorageAccountAccessTierPreference <StorageAccountAccessTier[]>]
      [-Tag <Hashtable>]
      [-TransportPreferredShipmentType <TransportShipmentTypes>]
      [-UserAssignedIdentity <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

既存のジョブのプロパティを更新します。

例

例 1: ユーザー割り当て ID を使用して Microsoft マネージドから顧客管理にデータボックスジョブの暗号化を更新する

$keyEncryptionDetails = New-AzDataBoxKeyEncryptionKeyObject -KekType "CustomerManaged" -IdentityProperty @{Type = "UserAssigned"; UserAssignedResourceId = "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName"} -KekUrl "keyIdentifier" -KekVaultResourceId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName"

$DebugPreference = "Continue"

# You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when update command fails.
# {
#   "Error": {
#     "Code": "StaticValidationGenericCountryCodeHasInvalidLength",
#     "Message": "The attribute country code does not meet length constraints.\r\nEnter a value with 2 characters for country code.",
#     "Details": [
#       null
#     ],
#     "Target": null
#   }
# } 

Update-AzDataBoxJob -Name "powershell10" -ResourceGroupName "resourceGroupName" -KeyEncryptionKey $keyEncryptionDetails -ContactDetail $contactDetail -ShippingAddress $ShippingDetails  -IdentityType "UserAssigned" -UserAssignedIdentity @{"/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName" = @{}}

$keyEncryptionDetails

KekType         KekUrl                                           KekVaultResourceId
-------         ------                                           ------------------
CustomerManaged keyIdentifier /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName

Name         Location Status        TransferType  SkuName IdentityType DeliveryType Detail
----         -------- ------        ------------  ------- ------------ ------------ ------
Powershell10 WestUS   DeviceOrdered ImportToAzure DataBox UserAssigned NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails

ユーザー割り当て ID を使用して、Microsoft マネージドからカスタマーマネージドへのデータボックスジョブの暗号化を更新します。

例 2: 2 つの更新プログラムでシステム ID を使用して Microsoft マネージドから顧客管理にデータボックスジョブの暗号化を更新する

$databoxUpdate = Update-AzDataBoxJob -Name "pwshTestSAssigned" -ResourceGroupName "resourceGroupName" -ContactDetail $contactDetail -ShippingAddress $ShippingDetails  -IdentityType "SystemAssigned"

$databoxUpdate.Identity

$keyEncryptionDetails = New-AzDataBoxKeyEncryptionKeyObject -KekType "CustomerManaged" -IdentityProperty @{Type = "SystemAssigned"} -KekUrl "keyIdentifier" -KekVaultResourceId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName"

$databoxUpdateWithCMK = Update-AzDataBoxJob -Name "pwshTestSAssigned" -ResourceGroupName "resourceGroupName" -ContactDetail $contactDetail -ShippingAddress $ShippingDetails  -KeyEncryptionKey $keyEncryptionDetails

$databoxUpdateWithCMK.Identity

$databoxUpdateWithCMK.Detail.KeyEncryptionKey

PrincipalId                          TenantId                             Type
-----------                          --------                             ----
920850f5-9b6b-4017-a81a-3dcafe348be7 72f988bf-86f1-41af-91ab-2d7cd011db47 SystemAssigned

PrincipalId                          TenantId                             Type
-----------                          --------                             ----
920850f5-9b6b-4017-a81a-3dcafe348be7 72f988bf-86f1-41af-91ab-2d7cd011db47 SystemAssigned

KekType         KekUrl                                           KekVaultResourceId
-------         ------                                           ------------------
CustomerManaged keyIdentifier /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName

Microsoft が管理するデータボックスジョブの暗号化を、sytem 割り当て ID を使用して顧客が管理する顧客に更新します。例 1 で説明したように、$DebugPreference = "Continue" で再実行されたエラーの場合

例 3: カスタマーマネージドキー暗号化で割り当てられたユーザーに割り当てられたシステムからデータボックスジョブを更新する

$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891"
$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial"

Update-AzDataBoxJob -Name "pwshTestSAssigned" -ResourceGroupName "resourceGroupName" -KeyEncryptionKey $keyEncryptionDetails -ContactDetail $contactDetail -ShippingAddress $ShippingDetails  -IdentityType "SystemAssigned,UserAssigned" -UserAssignedIdentity @{"/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName" = @{}}

カスタマーマネージドキー暗号化で割り当てられたユーザーに割り当てられたシステムからデータボックスジョブを更新します。例 1 で説明したように、$DebugPreference = "Continue" で再実行されたエラーの場合

パラメーター

-AsJob

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ContactDetail

通知と発送の連絡先の詳細。作成するには、CONTACTDETAIL プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IContactDetails
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ContactDetailContactName

ユーザーの連絡先名。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ContactDetailMobile

連絡先の携帯電話番号。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ContactDetailPhone

連絡先の電話番号。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ContactDetailPhoneExtension

連絡先の電話番号。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EncryptionPreferenceDoubleEncryption

ソフトウェアベースの暗号化有効化のセカンダリレイヤーを定義します。

型:	DoubleEncryption
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EncryptionPreferenceHardwareEncryption

ハードウェアレベルの暗号化を定義します (ディスクの場合のみ)

型:	HardwareEncryption
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IdentityType

ID の種類

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IfMatch

If-Match 条件を定義します。パッチは、サーバー上のジョブの ETag がこの値と一致する場合にのみ実行されます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-KeyEncryptionKey

ジョブのキー暗号化キー。構築するには、KEYENCRYPTIONKEY プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IKeyEncryptionKey
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

指定したリソースグループ内のジョブリソースの名前。ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用する必要があります

型:	String
Aliases:	JobName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoWait

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PreferencePreferredDataCenterRegion

優先されるデータセンターリージョン。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループ名

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReturnToCustomerPackageDetailCarrierAccountNumber

顧客ディスクの顧客の運送業者アカウント番号。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReturnToCustomerPackageDetailCarrierName

運送業者の名前。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReturnToCustomerPackageDetailTrackingId

出荷の追跡 ID。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReverseShippingDetail

お客様がデバイスを受け取りたい配送先住所。構築するには、REVERSESHIPPINGDETAIL プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IShippingAddress
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReverseTransportPreferredShipmentType

顧客が優先する出荷ロジスティクスの種類を示します。

型:	TransportShipmentTypes
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ShippingAddress

顧客の配送先住所。構築するには、SHIPPINGADDRESS プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IShippingAddress
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-StorageAccountAccessTierPreference

ストレージアカウントのアクセス層に関連する基本設定。

型:	StorageAccountAccessTier[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SubscriptionId

サブスクリプション ID

型:	String
配置:	Named
規定値:	(Get-AzContext).Subscription.Id
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Tag

リソースを記述するキー値ペアの一覧。これらのタグは、(リソースグループ間で) このリソースを表示およびグループ化する場合に使用できます。

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TransportPreferredShipmentType

顧客が優先する出荷ロジスティクスの種類を示します。

型:	TransportShipmentTypes
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UserAssignedIdentity

ユーザー割り当て ID

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

出力

IJobResource

次の方法で共有

Update-AzDataBoxJob

構文

説明

例

例 1: ユーザー割り当て ID を使用して Microsoft マネージドから顧客管理にデータボックスジョブの暗号化を更新する

例 2: 2 つの更新プログラムでシステム ID を使用して Microsoft マネージドから顧客管理にデータボックスジョブの暗号化を更新する

例 3: カスタマーマネージドキー暗号化で割り当てられたユーザーに割り当てられたシステムからデータボックスジョブを更新する

パラメーター

-AsJob

-Confirm

-ContactDetail

-ContactDetailContactName

-ContactDetailMobile

-ContactDetailPhone

-ContactDetailPhoneExtension

-DefaultProfile

-EncryptionPreferenceDoubleEncryption

-EncryptionPreferenceHardwareEncryption

-IdentityType

-IfMatch

-KeyEncryptionKey

-Name

-NoWait

-PreferencePreferredDataCenterRegion

-ResourceGroupName

-ReturnToCustomerPackageDetailCarrierAccountNumber

-ReturnToCustomerPackageDetailCarrierName

-ReturnToCustomerPackageDetailTrackingId

-ReverseShippingDetail

-ReverseTransportPreferredShipmentType

-ShippingAddress

-StorageAccountAccessTierPreference

-SubscriptionId

-Tag

-TransportPreferredShipmentType

-UserAssignedIdentity

-WhatIf

出力

その他のリソース

次の方法で共有

Update-AzDataBoxJob

構文

説明

例

例 1: ユーザー割り当て ID を使用して Microsoft マネージドから顧客管理にデータ ボックス ジョブの暗号化を更新する

例 2: 2 つの更新プログラムでシステム ID を使用して Microsoft マネージドから顧客管理にデータ ボックス ジョブの暗号化を更新する

例 3: カスタマー マネージド キー暗号化で割り当てられたユーザーに割り当てられたシステムからデータ ボックス ジョブを更新する

パラメーター

-AsJob

-Confirm

-ContactDetail

-ContactDetailContactName

-ContactDetailMobile

-ContactDetailPhone

-ContactDetailPhoneExtension

-DefaultProfile

-EncryptionPreferenceDoubleEncryption

-EncryptionPreferenceHardwareEncryption

-IdentityType

-IfMatch

-KeyEncryptionKey

-Name

-NoWait

-PreferencePreferredDataCenterRegion

-ResourceGroupName

-ReturnToCustomerPackageDetailCarrierAccountNumber

-ReturnToCustomerPackageDetailCarrierName

-ReturnToCustomerPackageDetailTrackingId

-ReverseShippingDetail

-ReverseTransportPreferredShipmentType

-ShippingAddress

-StorageAccountAccessTierPreference

-SubscriptionId

-Tag

-TransportPreferredShipmentType

-UserAssignedIdentity

-WhatIf

出力

その他のリソース

例 1: ユーザー割り当て ID を使用して Microsoft マネージドから顧客管理にデータボックスジョブの暗号化を更新する

例 2: 2 つの更新プログラムでシステム ID を使用して Microsoft マネージドから顧客管理にデータボックスジョブの暗号化を更新する

例 3: カスタマーマネージドキー暗号化で割り当てられたユーザーに割り当てられたシステムからデータボックスジョブを更新する