Managed Hsms - Get

Referencia

Servicio:: Key Vault

Versión de la API:: 2022-07-01

Obtiene el grupo de HSM administrado especificado.

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

Respuestas

Nombre	Tipo	Description
200 OK	ManagedHsm	Grupo de HSM administrado recuperado
204 No Content		Solicitud correcta. El recurso no existe.
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

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Retrieve a managed HSM Pool

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

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_get.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.get(
        resource_group_name="hsm-group",
        name="hsm1",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_Get.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

Respuesta de muestra

status code:: 200

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

status code:: 204

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 de 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 no coinciden ninguna regla de ipRules y de virtualNetworkRules. 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

Enumeración

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

Valor	Description
None

ActivationStatus

Enumeración

Estado de activación

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

CreateMode

Enumeración

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

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

Error

Object

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

Enumeración

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

Valor	Description
Application
Key
ManagedIdentity
User

ManagedHsm

Object

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	Ubicación de Azure admitida en la que 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

Object

Excepción del error.

Nombre	Tipo	Description
error	Error	Error del servidor.

ManagedHsmProperties

Object

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. Al establecer 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		Identificador URI del grupo de hsm administrados 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 (date-time)		La fecha de purga programada en UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Propiedades de dominio de seguridad de HSM administradas.
softDeleteRetentionInDays	integer (int32)	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 (uuid)		Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el grupo de HSM administrado.

ManagedHSMSecurityDomainProperties

Object

Las propiedades de dominio de seguridad del hsm administrado.

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

ManagedHsmSku

Object

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

Enumeración

Familia de SKU del grupo de HSM administrado

Valor	Description
B

ManagedHsmSkuName

Enumeración

SKU del grupo de HSM administrado

Valor	Description
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Object

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

Object

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 no coinciden ninguna regla de ipRules y de virtualNetworkRules. 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

Object

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

Object

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

Nombre	Tipo	Description
etag	string	Se modifica cada vez que hay 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

Object

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

Object

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

Enumeración

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

Valor	Description
Allow
Deny

NetworkRuleBypassOptions

Enumeración

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

Valor	Description
AzureServices
None

PrivateEndpointConnectionProvisioningState

Enumeración

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

Valor	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Enumeración

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

Valor	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumeración

Estado de aprovisionamiento.

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

PublicNetworkAccess

Enumeración

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

Valor	Description
Disabled
Enabled

SystemData

Object

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

Nombre	Tipo	Description
createdAt	string (date-time)	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 (date-time)	Marca de tiempo de la última modificación del recurso del almacén de claves (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.

Compartir a través de

Managed Hsms - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Retrieve a managed HSM Pool

Solicitud de ejemplo

Respuesta de muestra

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