Update-AzDataBoxJob
Atualiza as propriedades de um trabalho existente.
Sintaxe
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>]
Description
Atualiza as propriedades de um trabalho existente.
Exemplos
Exemplo 1: atualizar a criptografia de trabalho de caixa de dados da Microsoft gerenciada para o cliente gerenciado com identidades atribuídas pelo usuário
$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
Atualize a criptografia de trabalho de caixa de dados da Microsoft gerenciada para o cliente com identidades atribuídas pelo usuário.
Exemplo 2: atualizar a criptografia de trabalho de caixa de dados da Microsoft gerenciada para o cliente com identidades do sistema em 2 atualizações
$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
Atualize a criptografia de trabalho de caixa de dados da Microsoft gerenciada para o cliente gerenciado pelo cliente com a identidade atribuída pelo sytem. Para qualquer falha, execute novamente com $DebugPreference = "Continuar", conforme mencionado no exemplo 1
Exemplo 3: atualizar o trabalho de caixa de dados do sistema atribuído ao usuário atribuído com criptografia de chave gerenciada pelo cliente
$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" = @{}}
Atualize o trabalho de caixa de dados do sistema atribuído ao usuário atribuído com a criptografia de chave gerenciada pelo cliente. Para qualquer falha, execute novamente com $DebugPreference = "Continuar", conforme mencionado no exemplo 1
Parâmetros
-AsJob
Executar o comando como um trabalho
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Confirm
Solicita a confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ContactDetail
Detalhes de contato para notificação e envio. Para construir, consulte a seção NOTES para propriedades CONTACTDETAIL e crie uma tabela de hash.
Tipo: | IContactDetails |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ContactDetailContactName
Nome do contato da pessoa.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ContactDetailMobile
Número de celular da pessoa de contato.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ContactDetailPhone
Número de telefone da pessoa de contato.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ContactDetailPhoneExtension
Número de extensão de telefone da pessoa de contato.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-DefaultProfile
O parâmetro DefaultProfile não está funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.
Tipo: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-EncryptionPreferenceDoubleEncryption
Define a camada secundária de habilitação de criptografia baseada em software.
Tipo: | DoubleEncryption |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-EncryptionPreferenceHardwareEncryption
Define a criptografia de nível de hardware (somente para disco)
Tipo: | HardwareEncryption |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-IdentityType
Tipo de identidade
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-IfMatch
Define a condição de If-Match. O patch será executado somente se a ETag do trabalho no servidor corresponder a esse valor.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-KeyEncryptionKey
Chave de criptografia de chave para o trabalho. Para construir, consulte a seção NOTES para propriedades KEYENCRYPTIONKEY e crie uma tabela de hash.
Tipo: | IKeyEncryptionKey |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Name
O nome do recurso de trabalho dentro do grupo de recursos especificado. os nomes de trabalho devem ter entre 3 e 24 caracteres de comprimento e usar apenas alfanumérico e sublinhado
Tipo: | String |
Aliases: | JobName |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-NoWait
Executar o comando de forma assíncrona
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-PreferencePreferredDataCenterRegion
Região preferencial do data center.
Tipo: | String[] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ResourceGroupName
O nome do grupo de recursos
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ReturnToCustomerPackageDetailCarrierAccountNumber
Número da conta da operadora do cliente para o disco do cliente.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ReturnToCustomerPackageDetailCarrierName
Nome da transportadora.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ReturnToCustomerPackageDetailTrackingId
Rastreando a ID da remessa.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ReverseShippingDetail
Endereço de envio em que o cliente deseja receber o dispositivo. Para construir, consulte a seção NOTES para propriedades REVERSESHIPPINGDETAIL e crie uma tabela de hash.
Tipo: | IShippingAddress |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ReverseTransportPreferredShipmentType
Indica o tipo de Logística de Remessa que o cliente preferiu.
Tipo: | TransportShipmentTypes |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ShippingAddress
Endereço de envio do cliente. Para construir, consulte a seção NOTES para propriedades SHIPPINGADDRESS e crie uma tabela de hash.
Tipo: | IShippingAddress |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-StorageAccountAccessTierPreference
Preferências relacionadas à Camada de Acesso de contas de armazenamento.
Tipo: | StorageAccountAccessTier[] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-SubscriptionId
A ID da assinatura
Tipo: | String |
Cargo: | Named |
Valor padrão: | (Get-AzContext).Subscription.Id |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Tag
A lista de pares de valores de chave que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos).
Tipo: | Hashtable |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-TransportPreferredShipmentType
Indica o tipo de Logística de Remessa que o cliente preferiu.
Tipo: | TransportShipmentTypes |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-UserAssignedIdentity
Identidades atribuídas pelo usuário
Tipo: | Hashtable |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Saídas
Azure PowerShell