Managed Hsms - Get

Référence

Service:: Key Vault

Version d'API:: 2022-07-01

Obtient le pool HSM managé spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom du pool HSM managé.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le pool HSM managé.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	ManagedHsm	Pool HSM managé récupéré
204 No Content		Demande réussie. La ressource n’existe pas.
Other Status Codes	ManagedHsmError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 204

Définitions

Nom	Description
ActionsRequired	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
ActivationStatus	État d’activation
CreateMode	Mode de création pour indiquer si la ressource est en cours de création ou est en cours de récupération à partir d’une ressource supprimée.
Error	Erreur du serveur.
identityType	Type d’identité qui a créé la ressource de coffre de clés.
ManagedHsm	Informations sur les ressources avec des détails étendus.
ManagedHsmError	Exception d'erreur.
ManagedHsmProperties	Propriétés du pool HSM managé
ManagedHSMSecurityDomainProperties	Propriétés du domaine de sécurité du hsm managé.
ManagedHsmSku	Détails de la référence SKU
ManagedHsmSkuFamily	Famille de références SKU du pool HSM managé
ManagedHsmSkuName	Référence SKU du pool HSM managé
MHSMIPRule	Règle régissant l’accessibilité d’un pool hsm managé à partir d’une adresse IP ou d’une plage ip spécifique.
MHSMNetworkRuleSet	Ensemble de règles régissant l’accessibilité réseau d’un pool hsm managé.
MHSMPrivateEndpoint	Propriétés de l’objet de point de terminaison privé.
MHSMPrivateEndpointConnectionItem	Élément de connexion de point de terminaison privé.
MHSMPrivateLinkServiceConnectionState	Objet qui représente l’état d’approbation de la connexion de liaison privée.
MHSMVirtualNetworkRule	Règle régissant l’accessibilité d’un pool hsm managé à partir d’un réseau virtuel spécifique.
NetworkRuleAction	Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette propriété n’est utilisée qu’après l’évaluation de la propriété bypass.
NetworkRuleBypassOptions	Indique le trafic qui peut contourner les règles réseau. Il peut s’agir de « AzureServices » ou « None ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ».
PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
PrivateEndpointServiceConnectionStatus	Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.
ProvisioningState	État d’approvisionnement.
PublicNetworkAccess	Contrôler l’autorisation sur le HSM managé à partir de réseaux publics.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.

ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

Nom	Type	Description
None	string

ActivationStatus

État d’activation

Nom	Type	Description
Active	string	Le pool HSM managé est actif.
Failed	string	Échec de l’activation du hsm managé.
NotActivated	string	Le pool HSM managé n’est pas encore activé.
Unknown	string	Une erreur inconnue s’est produite lors de l’activation du hsm managé.

CreateMode

Mode de création pour indiquer si la ressource est en cours de création ou est en cours de récupération à partir d’une ressource supprimée.

Nom	Type	Description
default	string	Créez un pool HSM managé. Il s'agit de l'option par défaut.
recover	string	Récupérez le pool HSM managé à partir d’une ressource supprimée de manière réversible.

Error

Erreur du serveur.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	L’erreur interne contient un code d’erreur plus spécifique.
message	string	Message d’erreur.

identityType

Type d’identité qui a créé la ressource de coffre de clés.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Informations sur les ressources avec des détails étendus.

Nom	Type	Description
id	string	L’ID de ressource Azure Resource Manager pour le pool HSM managé.
location	string	Emplacement Azure pris en charge où le pool HSM managé doit être créé.
name	string	Nom du pool HSM managé.
properties	ManagedHsmProperties	Propriétés du HSM managé
sku	ManagedHsmSku	Détails de la référence SKU
systemData	SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.
tags	object	Balises de ressource
type	string	Type de ressource du pool HSM managé.

ManagedHsmError

Exception d'erreur.

Nom	Type	Description
error	Error	Erreur du serveur.

ManagedHsmProperties

Propriétés du pool HSM managé

Nom	Type	Valeur par défaut	Description
createMode	CreateMode		Mode de création pour indiquer si la ressource est en cours de création ou est en cours de récupération à partir d’une ressource supprimée.
enablePurgeProtection	boolean	True	Propriété spécifiant si la protection contre la purge est activée pour ce pool HSM managé. La définition de cette propriété sur true active la protection contre la purge de ce pool HSM managé et de son contenu. Seul le service HSM managé peut lancer une suppression difficile et irrécupérable. L’activation de cette fonctionnalité est irréversible.
enableSoftDelete	boolean	True	Propriété permettant de spécifier si la fonctionnalité « suppression réversible » est activée pour ce pool HSM managé. La suppression réversible est activée par défaut pour tous les HSM managés et est immuable.
hsmUri	string		URI du pool hsm managé pour effectuer des opérations sur les clés.
initialAdminObjectIds	string[]		Tableau des ID d’objet des administrateurs initiaux pour ce pool hsm managé.
networkAcls	MHSMNetworkRuleSet		Règles régissant l’accessibilité du coffre de clés à partir d’emplacements réseau spécifiques.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Liste des connexions de point de terminaison privé associées au pool hsm managé.
provisioningState	ProvisioningState		État d’approvisionnement.
publicNetworkAccess	PublicNetworkAccess	Enabled	Contrôler l’autorisation sur le HSM managé à partir de réseaux publics.
scheduledPurgeDate	string		Date de purge planifiée en UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Propriétés de domaine de sécurité HSM managées.
softDeleteRetentionInDays	integer	90	Jours de rétention des données supprimés de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pendant la période de rétention configurée ou pendant une période par défaut de 90 jours. Il accepte des valeurs comprises entre 7 et 90.
statusMessage	string		Message d’état de la ressource.
tenantId	string		ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des demandes adressées au pool HSM managé.

ManagedHSMSecurityDomainProperties

Propriétés du domaine de sécurité du hsm managé.

Nom	Type	Description
activationStatus	ActivationStatus	État d’activation
activationStatusMessage	string	Message d’état d’activation.

ManagedHsmSku

Détails de la référence SKU

Nom	Type	Description
family	ManagedHsmSkuFamily	Famille de références SKU du pool HSM managé
name	ManagedHsmSkuName	Référence SKU du pool HSM managé

ManagedHsmSkuFamily

Famille de références SKU du pool HSM managé

Nom	Type	Description
B	string

ManagedHsmSkuName

Référence SKU du pool HSM managé

Nom	Type	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Règle régissant l’accessibilité d’un pool hsm managé à partir d’une adresse IP ou d’une plage ip spécifique.

Nom	Type	Description
value	string	Plage d’adresses IPv4 en notation CIDR, telle que « 124.56.78.91 » (adresse IP simple) ou « 124.56.78.0/24 » (toutes les adresses commençant par 124.56.78).

MHSMNetworkRuleSet

Ensemble de règles régissant l’accessibilité réseau d’un pool hsm managé.

Nom	Type	Description
bypass	NetworkRuleBypassOptions	Indique le trafic qui peut contourner les règles réseau. Il peut s’agir de « AzureServices » ou « None ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ».
defaultAction	NetworkRuleAction	Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette propriété n’est utilisée qu’après l’évaluation de la propriété bypass.
ipRules	MHSMIPRule[]	Liste des règles d’adresse IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Liste des règles de réseau virtuel.

MHSMPrivateEndpoint

Propriétés de l’objet de point de terminaison privé.

Nom	Type	Description
id	string	Identificateur complet de la ressource de point de terminaison privé.

MHSMPrivateEndpointConnectionItem

Élément de connexion de point de terminaison privé.

Nom	Type	Description
etag	string	Modifié chaque fois qu’il y a un changement dans l’état de la connexion de point de terminaison privé.
id	string	ID de la connexion de point de terminaison privé.
properties.privateEndpoint	MHSMPrivateEndpoint	Propriétés de l’objet de point de terminaison privé.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	État d’approbation de la connexion de liaison privée.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.

MHSMPrivateLinkServiceConnectionState

Objet qui représente l’état d’approbation de la connexion de liaison privée.

Nom	Type	Description
actionsRequired	ActionsRequired	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
description	string	Motif de l’approbation ou du rejet.
status	PrivateEndpointServiceConnectionStatus	Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.

MHSMVirtualNetworkRule

Règle régissant l’accessibilité d’un pool hsm managé à partir d’un réseau virtuel spécifique.

Nom	Type	Description
id	string	ID de ressource complet d’un sous-réseau vnet, tel que « /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnets1 ».

NetworkRuleAction

Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette propriété n’est utilisée qu’après l’évaluation de la propriété bypass.

Nom	Type	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Indique le trafic qui peut contourner les règles réseau. Il peut s’agir de « AzureServices » ou « None ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ».

Nom	Type	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom	Type	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

État d’approvisionnement.

Nom	Type	Description
Activated	string	Le pool HSM managé est prêt pour une utilisation normale.
Deleting	string	Le pool HSM managé est en cours de suppression.
Failed	string	L’approvisionnement du pool HSM managé a échoué.
Provisioning	string	Le pool HSM managé est en cours d’approvisionnement.
Restoring	string	Le pool HSM managé est en cours de restauration à partir d’une sauvegarde HSM complète.
SecurityDomainRestore	string	Le pool HSM managé attend une action de restauration du domaine de sécurité.
Succeeded	string	Le pool HSM managé a été entièrement provisionné.
Updating	string	Le pool HSM managé est en cours de mise à jour.

PublicNetworkAccess

Contrôler l’autorisation sur le HSM managé à partir de réseaux publics.

Nom	Type	Description
Disabled	string
Enabled	string

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.

Nom	Type	Description
createdAt	string	Horodatage de la création de la ressource de coffre de clés (UTC).
createdBy	string	Identité qui a créé la ressource key vault.
createdByType	identityType	Type d’identité qui a créé la ressource de coffre de clés.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource de coffre de clés (UTC).
lastModifiedBy	string	Identité qui a modifié la dernière ressource du coffre de clés.
lastModifiedByType	identityType	Type d’identité qui a modifié la dernière ressource du coffre de clés.

Partager via