Managed Hsms - Update

Referencia

Service:: Key Vault

API Version:: 2022-07-01

Actualice un grupo de HSM administrado en la suscripción especificada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre del grupo de HSM administrado
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el grupo de HSM administrado.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
location	string	La ubicación de Azure admitida donde se debe crear el grupo de HSM administrado.
properties	ManagedHsmProperties	Propiedades del HSM administrado
sku	ManagedHsmSku	Detalles de la SKU
tags	object	Etiquetas del recurso

Respuestas

Nombre	Tipo	Description
200 OK	ManagedHsm	Grupo de HSM administrado revisado
202 Accepted	ManagedHsm	Aceptado y la operación se completará de forma asincrónica. Headers Location: string
Other Status Codes	ManagedHsmError	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

ManagedHsm

Grupo de HSM administrado revisado

202 Accepted

ManagedHsm

Aceptado y la operación se completará de forma asincrónica.

Headers

Location: string

Other Status Codes

ManagedHsmError

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
ActionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
ActivationStatus	Estado de activación
CreateMode	Modo de creación para indicar si el recurso se está creando o se está recuperando de un recurso eliminado.
Error	Error del servidor.
identityType	Tipo de identidad que creó el recurso del almacén de claves.
ManagedHsm	Información de recursos con detalles extendidos.
ManagedHsmError	Excepción del error.
ManagedHsmProperties	Propiedades del grupo de HSM administrado
ManagedHSMSecurityDomainProperties	Las propiedades del dominio de seguridad del hsm administrado.
ManagedHsmSku	Detalles de la SKU
ManagedHsmSkuFamily	Familia de SKU del grupo de HSM administrado
ManagedHsmSkuName	SKU del grupo de HSM administrado
MHSMIPRule	Una regla que rige la accesibilidad de un grupo de hsm administrado desde una dirección IP específica o un intervalo ip.
MHSMNetworkRuleSet	Conjunto de reglas que rigen la accesibilidad de red de un grupo de hsm administrado.
MHSMPrivateEndpoint	Propiedades del objeto de punto de conexión privado.
MHSMPrivateEndpointConnectionItem	Elemento de conexión de punto de conexión privado.
MHSMPrivateLinkServiceConnectionState	Objeto que representa el estado de aprobación de la conexión de vínculo privado.
MHSMVirtualNetworkRule	Una regla que rige la accesibilidad de un grupo de hsm administrado desde una red virtual específica.
NetworkRuleAction	Acción predeterminada cuando ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass.
NetworkRuleBypassOptions	Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica, el valor predeterminado es "AzureServices".
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
PrivateEndpointServiceConnectionStatus	Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión.
ProvisioningState	Estado de aprovisionamiento.
PublicNetworkAccess	Controle el permiso para el HSM administrado desde redes públicas.
SystemData	Metadatos relacionados con la creación y la última modificación del recurso del almacén de claves.

ActionsRequired

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

Nombre	Tipo	Description
None	string

ActivationStatus

Estado de activación

Nombre	Tipo	Description
Active	string	El grupo de HSM administrado está activo.
Failed	string	No se pudo activar hsm administrado.
NotActivated	string	El grupo de HSM administrado aún no está activado.
Unknown	string	Error desconocido al activar hsm administrado.

CreateMode

Modo de creación para indicar si el recurso se está creando o se está recuperando de un recurso eliminado.

Nombre	Tipo	Description
default	string	Cree un nuevo grupo de HSM administrado. Ésta es la opción predeterminada.
recover	string	Recupere el grupo de HSM administrado de un recurso eliminado temporalmente.

Error

Error del servidor.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	El error interno contiene un código de error más específico.
message	string	El mensaje de error.

identityType

Tipo de identidad que creó el recurso del almacén de claves.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Información de recursos con detalles extendidos.

Nombre	Tipo	Description
id	string	El identificador de recurso de Azure Resource Manager para el grupo de HSM administrado.
location	string	La ubicación de Azure admitida donde se debe crear el grupo de HSM administrado.
name	string	Nombre del grupo de HSM administrado.
properties	ManagedHsmProperties	Propiedades del HSM administrado
sku	ManagedHsmSku	Detalles de la SKU
systemData	SystemData	Metadatos relacionados con la creación y la última modificación del recurso del almacén de claves.
tags	object	Etiquetas del recurso
type	string	Tipo de recurso del grupo de HSM administrado.

ManagedHsmError

Excepción del error.

Nombre	Tipo	Description
error	Error	Error del servidor.

ManagedHsmProperties

Propiedades del grupo de HSM administrado

Nombre	Tipo	Valor predeterminado	Description
createMode	CreateMode		Modo de creación para indicar si el recurso se está creando o se está recuperando de un recurso eliminado.
enablePurgeProtection	boolean	True	Propiedad que especifica si la protección contra purga está habilitada para este grupo de HSM administrado. Si se establece esta propiedad en true, se activa la protección frente a la purga de este grupo de HSM administrado y su contenido; solo el servicio HSM administrado puede iniciar una eliminación irrecuperable e irrecuperable. Habilitar esta funcionalidad es irreversible.
enableSoftDelete	boolean	True	Propiedad para especificar si la funcionalidad de "eliminación temporal" está habilitada para este grupo de HSM administrado. La eliminación temporal está habilitada de forma predeterminada para todos los HSM administrados y es inmutable.
hsmUri	string		URI del grupo de hsm administrado para realizar operaciones en claves.
initialAdminObjectIds	string[]		Matriz de identificadores de objeto de administradores iniciales para este grupo de hsm administrado.
networkAcls	MHSMNetworkRuleSet		Reglas que rigen la accesibilidad del almacén de claves desde ubicaciones de red específicas.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Lista de conexiones de punto de conexión privado asociadas al grupo de hsm administrado.
provisioningState	ProvisioningState		Estado de aprovisionamiento.
publicNetworkAccess	PublicNetworkAccess	Enabled	Controle el permiso para el HSM administrado desde redes públicas.
scheduledPurgeDate	string		Fecha de purga programada en UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Propiedades de dominio de seguridad de HSM administradas.
softDeleteRetentionInDays	integer	90	Días de retención de datos eliminados temporalmente. Al eliminar un HSM o una clave, permanecerá recuperable durante el período de retención configurado o durante un período predeterminado de 90 días. Acepta valores entre 7 y 90.
statusMessage	string		Mensaje de estado del recurso.
tenantId	string		Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el grupo de HSM administrado.

ManagedHSMSecurityDomainProperties

Las propiedades del dominio de seguridad del hsm administrado.

Nombre	Tipo	Description
activationStatus	ActivationStatus	Estado de activación
activationStatusMessage	string	Mensaje de estado de activación.

ManagedHsmSku

Detalles de la SKU

Nombre	Tipo	Description
family	ManagedHsmSkuFamily	Familia de SKU del grupo de HSM administrado
name	ManagedHsmSkuName	SKU del grupo de HSM administrado

ManagedHsmSkuFamily

Familia de SKU del grupo de HSM administrado

Nombre	Tipo	Description
B	string

ManagedHsmSkuName

SKU del grupo de HSM administrado

Nombre	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Una regla que rige la accesibilidad de un grupo de hsm administrado desde una dirección IP específica o un intervalo ip.

Nombre	Tipo	Description
value	string	Intervalo de direcciones IPv4 en notación CIDR, como "124.56.78.91" (dirección IP simple) o "124.56.78.0/24" (todas las direcciones que comienzan por 124.56.78).

MHSMNetworkRuleSet

Conjunto de reglas que rigen la accesibilidad de red de un grupo de hsm administrado.

Nombre	Tipo	Description
bypass	NetworkRuleBypassOptions	Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica, el valor predeterminado es "AzureServices".
defaultAction	NetworkRuleAction	Acción predeterminada cuando ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass.
ipRules	MHSMIPRule[]	Lista de reglas de direcciones IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Lista de reglas de red virtual.

MHSMPrivateEndpoint

Propiedades del objeto de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador completo del recurso de punto de conexión privado.

MHSMPrivateEndpointConnectionItem

Elemento de conexión de punto de conexión privado.

Nombre	Tipo	Description
etag	string	Se modifica cada vez que se produce un cambio en el estado de la conexión de punto de conexión privado.
id	string	Identificador de la conexión de punto de conexión privado.
properties.privateEndpoint	MHSMPrivateEndpoint	Propiedades del objeto de punto de conexión privado.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Estado de aprobación de la conexión de vínculo privado.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.

MHSMPrivateLinkServiceConnectionState

Objeto que representa el estado de aprobación de la conexión de vínculo privado.

Nombre	Tipo	Description
actionsRequired	ActionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión.

MHSMVirtualNetworkRule

Una regla que rige la accesibilidad de un grupo de hsm administrado desde una red virtual específica.

Nombre	Tipo	Description
id	string	Identificador de recurso completo de una subred de red virtual, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Acción predeterminada cuando ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass.

Nombre	Tipo	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica, el valor predeterminado es "AzureServices".

Nombre	Tipo	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

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

PrivateEndpointServiceConnectionStatus

Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Estado de aprovisionamiento.

Nombre	Tipo	Description
Activated	string	El grupo de HSM administrado está listo para su uso normal.
Deleting	string	El grupo de HSM administrado se está eliminando actualmente.
Failed	string	Error en el aprovisionamiento del grupo de HSM administrado.
Provisioning	string	El grupo de HSM administrado se está aprovisionando actualmente.
Restoring	string	El grupo de HSM administrado se está restaurando a partir de la copia de seguridad completa de HSM.
SecurityDomainRestore	string	El grupo de HSM administrado está esperando una acción de restauración del dominio de seguridad.
Succeeded	string	El grupo de HSM administrado se ha aprovisionado completamente.
Updating	string	El grupo de HSM administrado se está actualizando actualmente.

PublicNetworkAccess

Controle el permiso para el HSM administrado desde redes públicas.

Nombre	Tipo	Description
Disabled	string
Enabled	string

SystemData

Metadatos relacionados con la creación y la última modificación del recurso del almacén de claves.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de la creación de recursos del almacén de claves (UTC).
createdBy	string	Identidad que creó el recurso del almacén de claves.
createdByType	identityType	Tipo de identidad que creó el recurso del almacén de claves.
lastModifiedAt	string	Marca de tiempo del recurso del almacén de claves última modificación (UTC).
lastModifiedBy	string	Identidad que modificó por última vez el recurso del almacén de claves.
lastModifiedByType	identityType	Tipo de identidad que modificó por última vez el recurso del almacén de claves.

Managed Hsms - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Update an existing managed HSM Pool

Sample Request

Sample Response

Definiciones

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 adicionales