Managed Hsms - Update

Referência

Service:: Key Vault

API Version:: 2022-07-01

Atualize um pool de HSM gerenciado na assinatura especificada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do pool de HSM gerenciado
resourceGroupName	path	True	string	Nome do grupo de recursos que contém o pool de HSM gerenciado.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
location	string	O local do Azure com suporte em que o pool de HSM gerenciado deve ser criado.
properties	ManagedHsmProperties	Propriedades do HSM gerenciado
sku	ManagedHsmSku	Detalhes do SKU
tags	object	Marcações de recursos

Respostas

Nome	Tipo	Description
200 OK	ManagedHsm	Pool de HSM gerenciado com patch
202 Accepted	ManagedHsm	Aceito e a operação será concluída de forma assíncrona. Headers Location: string
Other Status Codes	ManagedHsmError	A resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

ManagedHsm

Pool de HSM gerenciado com patch

202 Accepted

ManagedHsm

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

Headers

Location: string

Other Status Codes

ManagedHsmError

A resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Update an existing managed HSM Pool

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"
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_hsms.begin_update(
        resource_group_name="hsm-group",
        name="hsm1",
        parameters={"tags": {"Dept": "hsm", "Environment": "dogfood", "Slice": "A"}},
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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"
  }
}

Status code:: 202

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

Response Body

{
  "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

Nome	Description
ActionsRequired	Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.
ActivationStatus	Status da ativação
CreateMode	O modo de criação para indicar se o recurso está sendo criado ou está sendo recuperado de um recurso excluído.
Error	O erro do servidor.
identityType	O tipo de identidade que criou o recurso do cofre de chaves.
ManagedHsm	Informações de recurso com detalhes estendidos.
ManagedHsmError	A exceção do erro.
ManagedHsmProperties	Propriedades do pool de HSM gerenciado
ManagedHSMSecurityDomainProperties	As propriedades de domínio de segurança do hsm gerenciado.
ManagedHsmSku	Detalhes do SKU
ManagedHsmSkuFamily	Família de SKU do pool de HSM gerenciado
ManagedHsmSkuName	SKU do pool de HSM gerenciado
MHSMIPRule	Uma regra que rege a acessibilidade de um pool de hsm gerenciado de um endereço IP ou intervalo de ip específico.
MHSMNetworkRuleSet	Um conjunto de regras que regem a acessibilidade de rede de um pool de hsm gerenciado.
MHSMPrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
MHSMPrivateEndpointConnectionItem	Item de conexão de ponto de extremidade privado.
MHSMPrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da conexão de link privado.
MHSMVirtualNetworkRule	Uma regra que rege a acessibilidade de um pool de hsm gerenciado de uma rede virtual específica.
NetworkRuleAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada.
NetworkRuleBypassOptions	Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'.
PrivateEndpointConnectionProvisioningState	Estado de provisionamento da conexão de ponto de extremidade privado.
PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.
ProvisioningState	Estado de provisionamento.
PublicNetworkAccess	Controle a permissão para o HSM gerenciado de redes públicas.
SystemData	Metadados relativos à criação e última modificação do recurso do cofre de chaves.

ActionsRequired

Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.

Nome	Tipo	Description
None	string

ActivationStatus

Status da ativação

Nome	Tipo	Description
Active	string	O pool de HSM gerenciado está ativo.
Failed	string	Falha ao ativar o hsm gerenciado.
NotActivated	string	O pool de HSM gerenciado ainda não está ativado.
Unknown	string	Ocorreu um erro desconhecido ao ativar o hsm gerenciado.

CreateMode

O modo de criação para indicar se o recurso está sendo criado ou está sendo recuperado de um recurso excluído.

Nome	Tipo	Description
default	string	Crie um novo pool de HSM gerenciado. Essa é a opção padrão.
recover	string	Recupere o pool de HSM gerenciado de um recurso de exclusão reversível.

Error

O erro do servidor.

Nome	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.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Informações de recurso com detalhes estendidos.

Nome	Tipo	Description
id	string	O Azure Resource Manager ID do recurso para o pool de HSM gerenciado.
location	string	O local do Azure com suporte em que o pool de HSM gerenciado deve ser criado.
name	string	O nome do pool de HSM gerenciado.
properties	ManagedHsmProperties	Propriedades do HSM gerenciado
sku	ManagedHsmSku	Detalhes do SKU
systemData	SystemData	Metadados relativos à criação e última modificação do recurso do cofre de chaves.
tags	object	Marcações de recursos
type	string	O tipo de recurso do pool de HSM gerenciado.

ManagedHsmError

A exceção do erro.

Nome	Tipo	Description
error	Error	O erro do servidor.

ManagedHsmProperties

Propriedades do pool de HSM gerenciado

Nome	Tipo	Valor padrão	Description
createMode	CreateMode		O modo de criação para indicar se o recurso está sendo criado ou está sendo recuperado de um recurso excluído.
enablePurgeProtection	boolean	True	Propriedade que especifica se a proteção contra limpeza está habilitada para esse pool de HSM gerenciado. Definir essa propriedade como true ativa a proteção contra limpeza para esse pool de HSM gerenciado e seu conteúdo – somente o serviço HSM Gerenciado pode iniciar uma exclusão dura e irrecuperável. Habilitar essa funcionalidade é irreversível.
enableSoftDelete	boolean	True	Propriedade para especificar se a funcionalidade "exclusão reversível" está habilitada para esse pool de HSM gerenciado. A exclusão reversível é habilitada por padrão para todos os HSMs gerenciados e é imutável.
hsmUri	string		O URI do pool de hsm gerenciado para executar operações em chaves.
initialAdminObjectIds	string[]		Matriz de IDs de objeto de administradores iniciais para esse pool de hsm gerenciado.
networkAcls	MHSMNetworkRuleSet		Regras que regem a acessibilidade do cofre de chaves de locais de rede específicos.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Lista de conexões de ponto de extremidade privado associadas ao pool de hsm gerenciado.
provisioningState	ProvisioningState		Estado de provisionamento.
publicNetworkAccess	PublicNetworkAccess	Enabled	Controle a permissão para o HSM gerenciado de redes públicas.
scheduledPurgeDate	string		A data de limpeza agendada em UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Propriedades de domínio de segurança HSM gerenciadas.
softDeleteRetentionInDays	integer	90	Dias de retenção de dados excluídos temporariamente. Quando você excluir um HSM ou uma chave, ele permanecerá recuperável pelo período de retenção configurado ou por um período padrão de 90 dias. Ele aceita valores entre 7 e 90.
statusMessage	string		Mensagem de Status do Recurso.
tenantId	string		A ID de locatário do Azure Active Directory que deve ser usada para autenticar solicitações no pool de HSM gerenciado.

ManagedHSMSecurityDomainProperties

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

Nome	Tipo	Description
activationStatus	ActivationStatus	Status da ativação
activationStatusMessage	string	Mensagem de Status de Ativação.

ManagedHsmSku

Detalhes do SKU

Nome	Tipo	Description
family	ManagedHsmSkuFamily	Família de SKU do pool de HSM gerenciado
name	ManagedHsmSkuName	SKU do pool de HSM gerenciado

ManagedHsmSkuFamily

Família de SKU do pool de HSM gerenciado

Nome	Tipo	Description
B	string

ManagedHsmSkuName

SKU do pool de HSM gerenciado

Nome	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Uma regra que rege a acessibilidade de um pool de hsm gerenciado de um endereço IP ou intervalo de ip específico.

Nome	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 pool de hsm gerenciado.

Nome	Tipo	Description
bypass	NetworkRuleBypassOptions	Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'.
defaultAction	NetworkRuleAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada.
ipRules	MHSMIPRule[]	A lista de regras de endereço IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	A lista de regras de rede virtual.

MHSMPrivateEndpoint

Propriedades do objeto de ponto de extremidade privado.

Nome	Tipo	Description
id	string	Identificador completo do recurso de ponto de extremidade privado.

MHSMPrivateEndpointConnectionItem

Item de conexão de ponto de extremidade privado.

Nome	Tipo	Description
etag	string	Modificado sempre que houver uma alteração no estado da conexão de ponto de extremidade privado.
id	string	Id da conexão de ponto de extremidade privado.
properties.privateEndpoint	MHSMPrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Estado de aprovação da conexão de link privado.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de provisionamento da conexão de ponto de extremidade privado.

MHSMPrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da conexão de link privado.

Nome	Tipo	Description
actionsRequired	ActionsRequired	Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.
description	string	O motivo da aprovação ou rejeição.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.

MHSMVirtualNetworkRule

Uma regra que rege a acessibilidade de um pool de hsm gerenciado de uma rede virtual específica.

Nome	Tipo	Description
id	string	ID de recurso completa de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.

NetworkRuleAction

A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada.

Nome	Tipo	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'.

Nome	Tipo	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Estado de provisionamento da conexão de ponto de extremidade privado.

Nome	Tipo	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

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

Nome	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Estado de provisionamento.

Nome	Tipo	Description
Activated	string	O pool de HSM gerenciado está pronto para uso normal.
Deleting	string	O pool de HSM gerenciado está sendo excluído no momento.
Failed	string	Falha no provisionamento do pool de HSM gerenciado.
Provisioning	string	O pool de HSM gerenciado está sendo provisionado no momento.
Restoring	string	O pool de HSM gerenciado está sendo restaurado do backup HSM completo.
SecurityDomainRestore	string	O pool de HSM gerenciado está aguardando uma ação de restauração de domínio de segurança.
Succeeded	string	O pool de HSM gerenciado foi provisionado por completo.
Updating	string	O pool de HSM gerenciado está sendo atualizado no momento.

PublicNetworkAccess

Controle a permissão para o HSM gerenciado de redes públicas.

Nome	Tipo	Description
Disabled	string
Enabled	string

SystemData

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

Nome	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 do recurso de cofre de chaves última modificação (UTC).
lastModifiedBy	string	A identidade que modificou o recurso do cofre de chaves pela última vez.
lastModifiedByType	identityType	O tipo de identidade que modificou pela última vez o recurso do cofre de chaves.

Managed Hsms - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

Update an existing managed HSM Pool

Sample Request

Sample Response

Definições

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

Recursos adicionais