Managed Hsms - Update

Riferimento

Servizio:: Key Vault

Versione API:: 2022-07-01

Aggiornare un pool di moduli di protezione hardware gestito nella sottoscrizione specificata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome del pool di moduli di protezione hardware gestito
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene il pool di moduli di protezione hardware gestito.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione api client.

Corpo della richiesta

Nome	Tipo	Descrizione
location	string	Percorso di Azure supportato in cui deve essere creato il pool di moduli di protezione hardware gestito.
properties	ManagedHsmProperties	Proprietà del modulo di protezione hardware gestito
sku	ManagedHsmSku	Dettagli SKU
tags	object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	ManagedHsm	Pool HSM gestito con patch
202 Accepted	ManagedHsm	Accettato e l'operazione verrà completata in modo asincrono. Intestazioni Location: string
Other Status Codes	ManagedHsmError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

ManagedHsm

Pool HSM gestito con patch

202 Accepted

ManagedHsm

Accettato e l'operazione verrà completata in modo asincrono.

Intestazioni

Location: string

Other Status Codes

ManagedHsmError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
ActivationStatus	Stato attivazione
CreateMode	Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata.
Error	Errore del server.
identityType	Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
ManagedHsm	Informazioni sulle risorse con dettagli estesi.
ManagedHsmError	Eccezione dell'errore.
ManagedHsmProperties	Proprietà del pool di moduli di protezione hardware gestito
ManagedHSMSecurityDomainProperties	Proprietà del dominio di sicurezza del modulo di protezione gestito.
ManagedHsmSku	Dettagli SKU
ManagedHsmSkuFamily	Famiglia di SKU del pool di moduli di protezione hardware gestito
ManagedHsmSkuName	SKU del pool di moduli di protezione hardware gestito
MHSMIPRule	Regola che regola l'accessibilità di un pool di moduli di protezione hardware gestito da un indirizzo IP o un intervallo ip specifico.
MHSMNetworkRuleSet	Set di regole che regolano l'accessibilità di rete di un pool hsm gestito.
MHSMPrivateEndpoint	Proprietà dell'oggetto endpoint privato.
MHSMPrivateEndpointConnectionItem	Elemento di connessione dell'endpoint privato.
MHSMPrivateLinkServiceConnectionState	Oggetto che rappresenta lo stato di approvazione della connessione al collegamento privato.
MHSMVirtualNetworkRule	Regola che regola l'accessibilità di un pool di moduli di protezione hardware gestito da una rete virtuale specifica.
NetworkRuleAction	Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Questa opzione viene utilizzata solo dopo la valutazione della proprietà bypass.
NetworkRuleBypassOptions	Indica il traffico che può ignorare le regole di rete. Può trattarsi di 'AzureServices' o 'None'. Se non è specificato, il valore predefinito è "AzureServices".
PrivateEndpointConnectionProvisioningState	Stato di provisioning della connessione dell'endpoint privato.
PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.
ProvisioningState	Stato del provisioning.
PublicNetworkAccess	Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi.

ActionsRequired

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.

Nome	Tipo	Descrizione
None	string

ActivationStatus

Stato attivazione

Nome	Tipo	Descrizione
Active	string	Il pool di moduli di protezione hardware gestito è attivo.
Failed	string	Impossibile attivare il modulo di protezione hardware gestito.
NotActivated	string	Il pool di moduli di protezione hardware gestito non è ancora attivato.
Unknown	string	Errore sconosciuto durante l'attivazione di hsm gestito.

CreateMode

Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata.

Nome	Tipo	Descrizione
default	string	Creare un nuovo pool di moduli di protezione hardware gestito. Questa è l'opzione predefinita.
recover	string	Ripristinare il pool di moduli di protezione hardware gestito da una risorsa eliminata temporanea.

Error

Errore del server.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	Error	L'errore interno contiene un codice di errore più specifico.
message	string	Messaggio di errore.

identityType

Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Informazioni sulle risorse con dettagli estesi.

Nome	Tipo	Descrizione
id	string	ID risorsa di Azure Resource Manager per il pool di moduli di protezione hardware gestito.
location	string	Percorso di Azure supportato in cui deve essere creato il pool di moduli di protezione hardware gestito.
name	string	Nome del pool di moduli di protezione hardware gestito.
properties	ManagedHsmProperties	Proprietà del modulo di protezione hardware gestito
sku	ManagedHsmSku	Dettagli SKU
systemData	SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi.
tags	object	Tag delle risorse
type	string	Tipo di risorsa del pool di moduli di protezione hardware gestito.

ManagedHsmError

Eccezione dell'errore.

Nome	Tipo	Descrizione
error	Error	Errore del server.

ManagedHsmProperties

Proprietà del pool di moduli di protezione hardware gestito

Nome	Tipo	Valore predefinito	Descrizione
createMode	CreateMode		Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata.
enablePurgeProtection	boolean	True	Proprietà che specifica se la protezione dall'eliminazione è abilitata per questo pool di moduli di protezione hardware gestito. L'impostazione di questa proprietà su true attiva la protezione dall'eliminazione per questo pool di moduli di protezione hardware gestito e il relativo contenuto. Solo il servizio HSM gestito può avviare un'eliminazione irreversibile e difficile. L'abilitazione di questa funzionalità è irreversibile.
enableSoftDelete	boolean	True	Proprietà per specificare se la funzionalità di eliminazione temporanea è abilitata per questo pool di moduli di protezione hardware gestito. L'eliminazione temporanea è abilitata per impostazione predefinita per tutti i moduli di protezione hardware gestiti ed è non modificabile.
hsmUri	string		URI del pool hsm gestito per l'esecuzione di operazioni sulle chiavi.
initialAdminObjectIds	string[]		Matrice di ID oggetto administrators iniziali per questo pool hsm gestito.
networkAcls	MHSMNetworkRuleSet		Regole che regolano l'accessibilità dell'insieme di credenziali delle chiavi da percorsi di rete specifici.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Elenco delle connessioni di endpoint privato associate al pool hsm gestito.
provisioningState	ProvisioningState		Stato del provisioning.
publicNetworkAccess	PublicNetworkAccess	Enabled	Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche.
scheduledPurgeDate	string		Data di eliminazione pianificata in formato UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Proprietà del dominio di sicurezza del modulo di protezione hardware gestito.
softDeleteRetentionInDays	integer	90	Giorni di conservazione dei dati eliminati soft. Quando si elimina un modulo di protezione hardware o una chiave, rimarrà recuperabile per il periodo di conservazione configurato o per un periodo predefinito di 90 giorni. Accetta valori compresi tra 7 e 90.
statusMessage	string		Messaggio di stato della risorsa.
tenantId	string		ID tenant di Azure Active Directory che deve essere usato per autenticare le richieste al pool di moduli di protezione hardware gestito.

ManagedHSMSecurityDomainProperties

Proprietà del dominio di sicurezza del modulo di protezione gestito.

Nome	Tipo	Descrizione
activationStatus	ActivationStatus	Stato attivazione
activationStatusMessage	string	Messaggio di stato attivazione.

ManagedHsmSku

Dettagli SKU

Nome	Tipo	Descrizione
family	ManagedHsmSkuFamily	Famiglia di SKU del pool di moduli di protezione hardware gestito
name	ManagedHsmSkuName	SKU del pool di moduli di protezione hardware gestito

ManagedHsmSkuFamily

Famiglia di SKU del pool di moduli di protezione hardware gestito

Nome	Tipo	Descrizione
B	string

ManagedHsmSkuName

SKU del pool di moduli di protezione hardware gestito

Nome	Tipo	Descrizione
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Regola che regola l'accessibilità di un pool di moduli di protezione hardware gestito da un indirizzo IP o un intervallo ip specifico.

Nome	Tipo	Descrizione
value	string	Intervallo di indirizzi IPv4 nella notazione CIDR, ad esempio "124.56.78.91" (indirizzo IP semplice) o "124.56.78.0/24" (tutti gli indirizzi che iniziano con 124.56.78).

MHSMNetworkRuleSet

Set di regole che regolano l'accessibilità di rete di un pool hsm gestito.

Nome	Tipo	Descrizione
bypass	NetworkRuleBypassOptions	Indica il traffico che può ignorare le regole di rete. Può trattarsi di 'AzureServices' o 'None'. Se non è specificato, il valore predefinito è "AzureServices".
defaultAction	NetworkRuleAction	Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Questa opzione viene utilizzata solo dopo la valutazione della proprietà bypass.
ipRules	MHSMIPRule[]	Elenco di regole di indirizzo IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Elenco di regole di rete virtuale.

MHSMPrivateEndpoint

Proprietà dell'oggetto endpoint privato.

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa dell'endpoint privato.

MHSMPrivateEndpointConnectionItem

Elemento di connessione dell'endpoint privato.

Nome	Tipo	Descrizione
etag	string	Modifica ogni volta che si verifica una modifica dello stato della connessione all'endpoint privato.
id	string	ID della connessione all'endpoint privato.
properties.privateEndpoint	MHSMPrivateEndpoint	Proprietà dell'oggetto endpoint privato.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Stato di approvazione della connessione di collegamento privato.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stato di provisioning della connessione dell'endpoint privato.

MHSMPrivateLinkServiceConnectionState

Oggetto che rappresenta lo stato di approvazione della connessione al collegamento privato.

Nome	Tipo	Descrizione
actionsRequired	ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
description	string	Motivo dell'approvazione o del rifiuto.
status	PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.

MHSMVirtualNetworkRule

Regola che regola l'accessibilità di un pool di moduli di protezione hardware gestito da una rete virtuale specifica.

Nome	Tipo	Descrizione
id	string	ID risorsa completo di una subnet della rete virtuale, ad esempio "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Questa opzione viene utilizzata solo dopo la valutazione della proprietà bypass.

Nome	Tipo	Descrizione
Allow	string
Deny	string

NetworkRuleBypassOptions

Indica il traffico che può ignorare le regole di rete. Può trattarsi di 'AzureServices' o 'None'. Se non è specificato, il valore predefinito è "AzureServices".

Nome	Tipo	Descrizione
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Stato di provisioning della connessione dell'endpoint privato.

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

PrivateEndpointServiceConnectionStatus

Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Stato del provisioning.

Nome	Tipo	Descrizione
Activated	string	Il pool di moduli di protezione hardware gestito è pronto per l'uso normale.
Deleting	string	Il pool di moduli di protezione hardware gestito è attualmente in fase di eliminazione.
Failed	string	Il provisioning del pool di moduli di protezione hardware gestito non è riuscito.
Provisioning	string	Il provisioning del pool di moduli di protezione hardware gestito è attualmente in corso.
Restoring	string	Il pool di moduli di protezione hardware gestito viene ripristinato dal backup completo del modulo di protezione hardware.
SecurityDomainRestore	string	Il pool di moduli di protezione hardware gestito è in attesa di un'azione di ripristino del dominio di sicurezza.
Succeeded	string	È stato effettuato il provisioning completo del pool di moduli di protezione hardware gestito.
Updating	string	Il pool di moduli di protezione hardware gestito è attualmente in fase di aggiornamento.

PublicNetworkAccess

Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse dell'insieme di credenziali delle chiavi (UTC).
createdBy	string	Identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
createdByType	identityType	Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa dell'insieme di credenziali delle chiavi (UTC).
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa dell'insieme di credenziali delle chiavi.
lastModifiedByType	identityType	Tipo di identità che ha modificato l'ultima risorsa dell'insieme di credenziali delle chiavi.

Condividi tramite

Managed Hsms - Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Update an existing managed HSM Pool

Esempio di richiesta

Risposta di esempio

Definizioni

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

Risorse aggiuntive