Partilhar via


Managed Hsms - Update

Atualize um Conjunto de HSM gerido na subscrição especificada.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}?api-version=2022-07-01

Parâmetros do URI

Name Em Necessário Tipo Description
name
path True

string

Nome do Conjunto de HSM gerido

resourceGroupName
path True

string

Nome do grupo de recursos que contém o conjunto de HSM gerido.

subscriptionId
path True

string

Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão da API do Cliente.

Corpo do Pedido

Name Tipo Description
location

string

A localização suportada do Azure onde deve ser criado o Conjunto de HSM gerido.

properties

ManagedHsmProperties

Propriedades do HSM gerido

sku

ManagedHsmSku

Detalhes do SKU

tags

object

Etiquetas de recursos

Respostas

Name Tipo Description
200 OK

ManagedHsm

Conjunto de HSM gerido com patches

202 Accepted

ManagedHsm

Aceite e a operação será concluída de forma assíncrona.

Cabeçalhos

Location: string

Other Status Codes

ManagedHsmError

A resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Update an existing managed HSM Pool

Pedido de amostra

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01

{
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}

Resposta da amostra

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": false,
    "softDeleteRetentionInDays": 90,
    "enablePurgeProtection": false,
    "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
    "provisioningState": "Succeeded",
    "statusMessage": "ManagedHsm is functional."
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
  "name": "hsm1",
  "type": "Microsoft.KeyVault/managedHSMs",
  "location": "westus",
  "sku": {
    "family": "B",
    "name": "Standard_B1"
  },
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}
Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9
{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": true,
    "softDeleteRetentionInDays": 90,
    "enablePurgeProtection": false,
    "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
    "provisioningState": "Updating",
    "statusMessage": "ManagedHsm is updating."
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
  "name": "hsm1",
  "type": "Microsoft.KeyVault/managedHSMs",
  "location": "westus",
  "sku": {
    "family": "B",
    "name": "Standard_B1"
  },
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}

Definições

Name Description
ActionsRequired

Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.

ActivationStatus

Estado de Ativação

CreateMode

O modo de criação para indicar se o recurso está a ser criado ou se está a ser recuperado de um recurso eliminado.

Error

O erro do servidor.

identityType

O tipo de identidade que criou o recurso do cofre de chaves.

ManagedHsm

Informações de recursos com detalhes expandidos.

ManagedHsmError

A exceção de erro.

ManagedHsmProperties

Propriedades do Conjunto de HSM gerido

ManagedHSMSecurityDomainProperties

As propriedades do domínio de segurança do hsm gerido.

ManagedHsmSku

Detalhes do SKU

ManagedHsmSkuFamily

Família de SKU do Conjunto de HSM gerido

ManagedHsmSkuName

SKU do Conjunto de HSM gerido

MHSMIPRule

Uma regra que rege a acessibilidade de um conjunto hsm gerido a partir de um endereço IP específico ou intervalo de IP.

MHSMNetworkRuleSet

Um conjunto de regras que regem a acessibilidade de rede de um conjunto hsm gerido.

MHSMPrivateEndpoint

Propriedades do objeto de ponto final privado.

MHSMPrivateEndpointConnectionItem

Item de ligação de ponto final privado.

MHSMPrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da ligação de ligação privada.

MHSMVirtualNetworkRule

Uma regra que rege a acessibilidade de um conjunto hsm gerido a partir de uma rede virtual específica.

NetworkRuleAction

A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.

NetworkRuleBypassOptions

Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "Nenhum". Se não for especificado, a predefinição é "AzureServices".

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamento da ligação de ponto final privado.

PrivateEndpointServiceConnectionStatus

Indica se a ligação foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.

ProvisioningState

Estado de aprovisionamento.

PublicNetworkAccess

Controlar a permissão para o HSM gerido a partir de redes públicas.

SystemData

Metadados relativos à criação e última modificação do recurso do cofre de chaves.

ActionsRequired

Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.

Name Tipo Description
None

string

ActivationStatus

Estado de Ativação

Name Tipo Description
Active

string

O Conjunto HSM gerido está ativo.

Failed

string

Falha ao ativar o hsm gerido.

NotActivated

string

O Conjunto HSM gerido ainda não está ativado.

Unknown

string

Ocorreu um erro desconhecido ao ativar o hsm gerido.

CreateMode

O modo de criação para indicar se o recurso está a ser criado ou se está a ser recuperado de um recurso eliminado.

Name Tipo Description
default

string

Crie um novo conjunto HSM gerido. Esta é a opção predefinida.

recover

string

Recuperar o conjunto de HSM gerido a partir de um recurso eliminado de forma recuperável.

Error

O erro do servidor.

Name Tipo Description
code

string

O código de erro.

innererror

Error

O erro interno contém um código de erro mais específico.

message

string

A mensagem de erro.

identityType

O tipo de identidade que criou o recurso do cofre de chaves.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ManagedHsm

Informações de recursos com detalhes expandidos.

Name Tipo Description
id

string

O ID de recurso Resource Manager do Azure para o Conjunto de HSM gerido.

location

string

A localização suportada do Azure onde deve ser criado o Conjunto de HSM gerido.

name

string

O nome do Conjunto HSM gerido.

properties

ManagedHsmProperties

Propriedades do HSM gerido

sku

ManagedHsmSku

Detalhes do SKU

systemData

SystemData

Metadados relativos à criação e última modificação do recurso do cofre de chaves.

tags

object

Etiquetas de recursos

type

string

O tipo de recurso do Conjunto de HSM gerido.

ManagedHsmError

A exceção de erro.

Name Tipo Description
error

Error

O erro do servidor.

ManagedHsmProperties

Propriedades do Conjunto de HSM gerido

Name Tipo Default value Description
createMode

CreateMode

O modo de criação para indicar se o recurso está a ser criado ou se está a ser recuperado de um recurso eliminado.

enablePurgeProtection

boolean

True

Propriedade que especifica se a proteção contra remoção está ativada para este conjunto de HSM gerido. Definir esta propriedade como verdadeiro ativa a proteção contra a remoção deste conjunto de HSM gerido e o respetivo conteúdo – apenas o serviço HSM Gerido pode iniciar uma eliminação difícil e irrecuperável. Ativar esta funcionalidade é irreversível.

enableSoftDelete

boolean

True

Propriedade para especificar se a funcionalidade "eliminação recuperável" está ativada para este conjunto de HSM gerido. A eliminação recuperável está ativada por predefinição para todos os HSMs geridos e é imutável.

hsmUri

string

O URI do conjunto hsm gerido para realizar operações em chaves.

initialAdminObjectIds

string[]

Matriz de IDs de objeto de administradores iniciais para este conjunto hsm gerido.

networkAcls

MHSMNetworkRuleSet

Regras que regem a acessibilidade do cofre de chaves a partir de localizações de rede específicas.

privateEndpointConnections

MHSMPrivateEndpointConnectionItem[]

Lista de ligações de pontos finais privados associadas ao conjunto hsm gerido.

provisioningState

ProvisioningState

Estado de aprovisionamento.

publicNetworkAccess

PublicNetworkAccess

Enabled

Controlar a permissão para o HSM gerido a partir de redes públicas.

scheduledPurgeDate

string

A data de remoção agendada em UTC.

securityDomainProperties

ManagedHSMSecurityDomainProperties

Propriedades do domínio de segurança HSM gerido.

softDeleteRetentionInDays

integer

90

Dias de retenção de dados eliminados de forma recuperável. Quando elimina um HSM ou uma chave, este permanecerá recuperável durante o período de retenção configurado ou durante um período predefinido de 90 dias. Aceita valores entre 7 e 90.

statusMessage

string

Mensagem de Estado do Recurso.

tenantId

string

O ID de inquilino do Azure Active Directory que deve ser utilizado para autenticar pedidos no conjunto de HSM gerido.

ManagedHSMSecurityDomainProperties

As propriedades do domínio de segurança do hsm gerido.

Name Tipo Description
activationStatus

ActivationStatus

Estado de Ativação

activationStatusMessage

string

Mensagem de Estado de Ativação.

ManagedHsmSku

Detalhes do SKU

Name Tipo Description
family

ManagedHsmSkuFamily

Família de SKU do Conjunto de HSM gerido

name

ManagedHsmSkuName

SKU do Conjunto de HSM gerido

ManagedHsmSkuFamily

Família de SKU do Conjunto de HSM gerido

Name Tipo Description
B

string

ManagedHsmSkuName

SKU do Conjunto de HSM gerido

Name Tipo Description
Custom_B32

string

Custom_B6

string

Standard_B1

string

MHSMIPRule

Uma regra que rege a acessibilidade de um conjunto hsm gerido a partir de um endereço IP específico ou intervalo de IP.

Name Tipo Description
value

string

Um intervalo de endereços IPv4 na notação CIDR, como "124.56.78.91" (endereço IP simples) ou "124.56.78.0/24" (todos os endereços que começam com 124.56.78).

MHSMNetworkRuleSet

Um conjunto de regras que regem a acessibilidade de rede de um conjunto hsm gerido.

Name Tipo Description
bypass

NetworkRuleBypassOptions

Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "Nenhum". Se não for especificado, a predefinição é "AzureServices".

defaultAction

NetworkRuleAction

A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.

ipRules

MHSMIPRule[]

A lista de regras de endereços IP.

virtualNetworkRules

MHSMVirtualNetworkRule[]

A lista de regras de rede virtual.

MHSMPrivateEndpoint

Propriedades do objeto de ponto final privado.

Name Tipo Description
id

string

Identificador completo do recurso de ponto final privado.

MHSMPrivateEndpointConnectionItem

Item de ligação de ponto final privado.

Name Tipo Description
etag

string

Modificado sempre que existir uma alteração no estado da ligação de ponto final privado.

id

string

ID da ligação de ponto final privado.

properties.privateEndpoint

MHSMPrivateEndpoint

Propriedades do objeto de ponto final privado.

properties.privateLinkServiceConnectionState

MHSMPrivateLinkServiceConnectionState

Estado de aprovação da ligação de ligação privada.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamento da ligação de ponto final privado.

MHSMPrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da ligação de ligação privada.

Name Tipo Description
actionsRequired

ActionsRequired

Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.

description

string

O motivo da aprovação ou rejeição.

status

PrivateEndpointServiceConnectionStatus

Indica se a ligação foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.

MHSMVirtualNetworkRule

Uma regra que rege a acessibilidade de um conjunto hsm gerido a partir de uma rede virtual específica.

Name Tipo Description
id

string

ID de recurso completo de uma sub-rede vnet, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.

Name Tipo Description
Allow

string

Deny

string

NetworkRuleBypassOptions

Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "Nenhum". Se não for especificado, a predefinição é "AzureServices".

Name Tipo Description
AzureServices

string

None

string

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamento da ligação de ponto final privado.

Name Tipo Description
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

Indica se a ligação foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningState

Estado de aprovisionamento.

Name Tipo Description
Activated

string

O conjunto HSM gerido está pronto para utilização normal.

Deleting

string

O Conjunto HSM gerido está atualmente a ser eliminado.

Failed

string

O aprovisionamento do Conjunto de HSM gerido falhou.

Provisioning

string

O Conjunto HSM gerido está atualmente a ser aprovisionado.

Restoring

string

O conjunto HSM gerido está a ser restaurado a partir da cópia de segurança completa do HSM.

SecurityDomainRestore

string

O conjunto HSM gerido está à espera de uma ação de restauro do domínio de segurança.

Succeeded

string

O Conjunto HSM gerido foi aprovisionado na totalidade.

Updating

string

O Conjunto HSM gerido está atualmente a ser atualizado.

PublicNetworkAccess

Controlar a permissão para o HSM gerido a partir de redes públicas.

Name Tipo Description
Disabled

string

Enabled

string

SystemData

Metadados relativos à criação e última modificação do recurso do cofre de chaves.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos do cofre de chaves (UTC).

createdBy

string

A identidade que criou o recurso do cofre de chaves.

createdByType

identityType

O tipo de identidade que criou o recurso do cofre de chaves.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso do cofre de chaves (UTC).

lastModifiedBy

string

A identidade que modificou pela última vez o recurso do cofre de chaves.

lastModifiedByType

identityType

O tipo de identidade que modificou pela última vez o recurso do cofre de chaves.