Managed Hsms - Update

Référence

Service:: Key Vault

Version d'API:: 2022-07-01

Mettez à jour un pool HSM managé dans l’abonnement spécifié.

PATCH 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 de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
location	string	Emplacement Azure pris en charge où le pool HSM managé doit être créé.
properties	ManagedHsmProperties	Propriétés du HSM managé
sku	ManagedHsmSku	Détails de la référence SKU
tags	object	Balises de ressources

Réponses

Nom	Type	Description
200 OK	ManagedHsm	Pool HSM managé corrigé
202 Accepted	ManagedHsm	Accepté et l’opération se termine de façon asynchrone. En-têtes Location: string
Other Status Codes	ManagedHsmError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

ManagedHsm

Pool HSM managé corrigé

202 Accepted

ManagedHsm

Accepté et l’opération se termine de façon asynchrone.

En-têtes

Location: string

Other Status Codes

ManagedHsmError

Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

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

Exemple de réponse

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

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

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

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 de l’activation
CreateMode	Mode de création pour indiquer si la ressource est en cours de création ou est récupérée à partir d’une ressource supprimée.
Error	Erreur du serveur.
identityType	Type d’identité qui a créé la ressource key vault.
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 d’adresses IP spécifiques.
MHSMNetworkRuleSet	Ensemble de règles régissant l’accessibilité réseau d’un pool hsm managé.
MHSMPrivateEndpoint	Propriétés de l’objet 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 opération est utilisée uniquement après l’évaluation de la propriété de contournement.
NetworkRuleBypassOptions	Indique ce que le trafic peut contourner les règles réseau. Il peut s’agir d'« AzureServices » ou de « Aucun ». 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ôlez 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 key vault.

ActionsRequired

Énumération

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

Valeur	Description
None

ActivationStatus

Énumération

État de l’activation

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

CreateMode

Énumération

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

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

Error

Object

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

Énumération

Type d’identité qui a créé la ressource key vault.

Valeur	Description
Application
Key
ManagedIdentity
User

ManagedHsm

Object

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

Nom	Type	Description
id	string	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 key vault.
tags	object	Balises de ressources
type	string	Type de ressource du pool HSM managé.

ManagedHsmError

Object

Exception d’erreur.

Nom	Type	Description
error	Error	Erreur du serveur.

ManagedHsmProperties

Object

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 récupérée à partir d’une ressource supprimée.
enablePurgeProtection	boolean	True	Propriété spécifiant si la protection contre le vidage est activée pour ce pool HSM managé. La définition de cette propriété sur true active la protection contre le vidage pour ce pool HSM managé et son contenu . seul le service HSM managé peut lancer une suppression irrécupérable difficile. 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 d’ID d’objet 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ôlez l’autorisation sur le HSM managé à partir de réseaux publics.
scheduledPurgeDate	string (date-time)		Date de vidage planifiée au format UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Propriétés de domaine de sécurité HSM gérées.
softDeleteRetentionInDays	integer (int32)	90	Jours de rétention des données supprimées de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pour la période de rétention configurée ou pendant une période par défaut de 90 jours. Elle accepte les valeurs comprises entre 7 et 90.
statusMessage	string		Message d’état de la ressource.
tenantId	string (uuid)		ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des requêtes auprès du pool HSM managé.

ManagedHSMSecurityDomainProperties

Object

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

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

ManagedHsmSku

Object

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

Énumération

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

Valeur	Description
B

ManagedHsmSkuName

Énumération

Référence SKU du pool HSM managé

Valeur	Description
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Object

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

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

Object

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

Nom	Type	Description
bypass	NetworkRuleBypassOptions	Indique ce que le trafic peut contourner les règles réseau. Il peut s’agir d'« AzureServices » ou de « Aucun ». 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 opération est utilisée uniquement après l’évaluation de la propriété de contournement.
ipRules	MHSMIPRule[]	Liste des règles d’adresse IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Liste des règles de réseau virtuel.

MHSMPrivateEndpoint

Object

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

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

MHSMPrivateEndpointConnectionItem

Object

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

Nom	Type	Description
etag	string	Modifié chaque fois qu’il existe une modification de 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

Object

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

Object

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 de réseau virtuel, tel que « /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1 ».

NetworkRuleAction

Énumération

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

Valeur	Description
Allow
Deny

NetworkRuleBypassOptions

Énumération

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

Valeur	Description
AzureServices
None

PrivateEndpointConnectionProvisioningState

Énumération

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

Valeur	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Énumération

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

Valeur	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Énumération

État d’approvisionnement.

Valeur	Description
Activated	Le pool HSM managé est prêt à être utilisé normalement.
Deleting	Le pool HSM managé est actuellement supprimé.
Failed	L’approvisionnement du pool HSM managé a échoué.
Provisioning	Le pool HSM managé est actuellement approvisionné.
Restoring	Le pool HSM managé est restauré à partir d’une sauvegarde HSM complète.
SecurityDomainRestore	Le pool HSM managé attend une action de restauration de domaine de sécurité.
Succeeded	Le pool HSM managé a été provisionné entièrement.
Updating	Le pool HSM managé est actuellement mis à jour.

PublicNetworkAccess

Énumération

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

Valeur	Description
Disabled
Enabled

SystemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource key vault.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources du 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 key vault.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de la ressource key vault (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 ressource du coffre de clés pour la dernière fois.

Partager via

Managed Hsms - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Update an existing managed HSM Pool

Exemple de requête

Exemple de réponse

Définitions

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

Ressources supplémentaires