Managed Hsms - Get
Ottiene il pool di moduli di protezione hardware gestito specificato.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}?api-version=2024-11-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
name
|
path | True |
string |
Nome del pool di moduli di protezione hardware gestito. |
|
resource
|
path | True |
string |
Nome del gruppo di risorse che contiene il pool di moduli di protezione hardware gestito. |
|
subscription
|
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 al servizio. |
|
api-version
|
query | True |
string |
Versione dell'API client. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
Pool di moduli hardware gestiti recuperato |
|
| 204 No Content |
Richiesta riuscita. La risorsa non esiste. |
|
| Other Status Codes |
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
Retrieve a managed HSM Pool
Esempio di richiesta
Risposta di esempio
{
"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"
}
}
Definizioni
| Nome | Descrizione |
|---|---|
|
Actions |
Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer. |
|
Activation |
Stato di attivazione |
|
Create |
Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata. |
| Error |
L'errore del server. |
|
Geo |
Stato di provisioning dell'area con replica geografica. |
|
identity |
Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi. |
|
Managed |
Informazioni sulle risorse con dettagli estesi. |
|
Managed |
Eccezione di errore. |
|
Managed |
Proprietà del pool di moduli hardware gestito |
|
Managed |
Proprietà del dominio di sicurezza del modulo di protezione hardware gestito. |
|
Managed |
Dettagli SKU |
|
Managed |
Famiglia di SKU del pool di moduli di protezione hardware gestito |
|
Managed |
SKU del pool di moduli di protezione hardware gestito |
|
Managed |
Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente) |
|
Managed |
Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned). |
|
MHSMGeo |
Un'area a cui è stato esteso il pool di moduli di protezione hardware gestito. |
| MHSMIPRule |
Regola che regola l'accessibilità di un pool di moduli di protezione hardware gestiti da un indirizzo IP o da un intervallo IP specifico. |
|
MHSMNetwork |
Set di regole che regolano l'accessibilità di rete di un pool di moduli hardware gestito. |
|
MHSMPrivate |
Proprietà dell'oggetto endpoint privato. |
|
MHSMPrivate |
Elemento di connessione dell'endpoint privato. |
|
MHSMPrivate |
Oggetto che rappresenta lo stato di approvazione della connessione di collegamento privato. |
|
MHSMVirtual |
Regola che regola l'accessibilità di un pool di moduli hardware gestiti da una rete virtuale specifica. |
|
Network |
Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass. |
|
Network |
Indica il traffico che può ignorare le regole di rete. Può trattarsi di "AzureServices" o "None". Se non specificato, il valore predefinito è "AzureServices". |
|
Private |
Stato di provisioning della connessione dell'endpoint privato. |
|
Private |
Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi. |
|
Provisioning |
Stato del provisioning. |
|
Public |
Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche. |
|
System |
Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi. |
|
User |
Proprietà di identità assegnate dall'utente |
ActionsRequired
Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.
| Valore | Descrizione |
|---|---|
| None |
ActivationStatus
Stato di attivazione
| Valore | Descrizione |
|---|---|
| Active |
Il pool di moduli di protezione hardware gestito è attivo. |
| NotActivated |
Il pool di moduli di protezione hardware gestito non è ancora attivato. |
| Unknown |
Si è verificato un errore sconosciuto durante l'attivazione dell'hsm gestito. |
| Failed |
Impossibile attivare l'hsm gestito. |
CreateMode
Modalità di creazione per indicare se la risorsa viene creata o recuperata da una risorsa eliminata.
| Valore | Descrizione |
|---|---|
| recover |
Ripristinare il pool di moduli di protezione hardware gestito da una risorsa eliminata temporaneamente. |
| default |
Creare un nuovo pool di moduli di protezione hardware gestito. Si tratta dell'opzione predefinita. |
Error
L'errore del server.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Codice di errore. |
| innererror |
L'errore interno, contiene un codice di errore più specifico. |
|
| message |
string |
Messaggio di errore. |
GeoReplicationRegionProvisioningState
Stato di provisioning dell'area con replica geografica.
| Valore | Descrizione |
|---|---|
| Preprovisioning | |
| Provisioning | |
| Succeeded | |
| Failed | |
| Deleting | |
| Cleanup |
identityType
Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
| Valore | Descrizione |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
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. |
| identity |
Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente) |
|
| 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 |
Proprietà del modulo di protezione hardware gestito |
|
| sku |
Dettagli SKU |
|
| 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 di errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
L'errore del server. |
ManagedHsmProperties
Proprietà del pool di moduli hardware gestito
| Nome | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| 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 dura. 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 di moduli hardware gestito per l'esecuzione di operazioni sulle chiavi. |
|
| initialAdminObjectIds |
string[] |
Matrice di ID oggetto administrators iniziali per questo pool di moduli di protezione hardware gestito. |
|
| networkAcls |
Regole che regolano l'accessibilità dell'insieme di credenziali delle chiavi da percorsi di rete specifici. |
||
| privateEndpointConnections |
Elenco delle connessioni endpoint private associate al pool di moduli hardware gestiti. |
||
| provisioningState |
Stato del provisioning. |
||
| publicNetworkAccess | Enabled |
Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche. |
|
| regions |
Elenco di tutte le aree associate al pool di moduli di protezione hardware gestito. |
||
| scheduledPurgeDate |
string (date-time) |
La data di eliminazione pianificata in UTC. |
|
| securityDomainProperties |
Proprietà del dominio di sicurezza HSM gestito. |
||
| softDeleteRetentionInDays |
integer (int32) |
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 (uuid) |
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 hardware gestito.
| Nome | Tipo | Descrizione |
|---|---|---|
| activationStatus |
Stato di attivazione |
|
| activationStatusMessage |
string |
Messaggio di stato dell'attivazione. |
ManagedHsmSku
Dettagli SKU
| Nome | Tipo | Descrizione |
|---|---|---|
| family |
Famiglia di SKU del pool di moduli di protezione hardware gestito |
|
| name |
SKU del pool di moduli di protezione hardware gestito |
ManagedHsmSkuFamily
Famiglia di SKU del pool di moduli di protezione hardware gestito
| Valore | Descrizione |
|---|---|
| B | |
| C |
ManagedHsmSkuName
SKU del pool di moduli di protezione hardware gestito
| Valore | Descrizione |
|---|---|
| Standard_B1 | |
| Custom_B32 | |
| Custom_B6 | |
| Custom_C42 | |
| Custom_C10 |
ManagedServiceIdentity
Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)
| Nome | Tipo | Descrizione |
|---|---|---|
| principalId |
string (uuid) |
ID entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema. |
| tenantId |
string (uuid) |
ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema. |
| type |
Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned). |
|
| userAssignedIdentities |
<string,
User |
identità User-Assigned |
ManagedServiceIdentityType
Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
| Valore | Descrizione |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned,UserAssigned |
MHSMGeoReplicatedRegion
Un'area a cui è stato esteso il pool di moduli di protezione hardware gestito.
| Nome | Tipo | Descrizione |
|---|---|---|
| isPrimary |
boolean |
Valore booleano che indica se l'area è l'area primaria o un'area secondaria. |
| name |
string |
Nome dell'area geografica replicata. |
| provisioningState |
Stato di provisioning dell'area con replica geografica. |
MHSMIPRule
Regola che regola l'accessibilità di un pool di moduli di protezione hardware gestiti da un indirizzo IP o da 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 di moduli hardware gestito.
| Nome | Tipo | Descrizione |
|---|---|---|
| bypass |
Indica il traffico che può ignorare le regole di rete. Può trattarsi di "AzureServices" o "None". Se non specificato, il valore predefinito è "AzureServices". |
|
| defaultAction |
Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass. |
|
| ipRules |
Elenco delle regole degli indirizzi IP. |
|
| virtualNetworkRules |
Elenco delle regole di rete virtuale. |
MHSMPrivateEndpoint
Proprietà dell'oggetto endpoint privato.
| Nome | Tipo | Descrizione |
|---|---|---|
| id |
string |
Identificatore completo della risorsa 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 |
Proprietà dell'oggetto endpoint privato. |
|
| properties.privateLinkServiceConnectionState |
Stato di approvazione della connessione al collegamento privato. |
|
| properties.provisioningState |
Stato di provisioning della connessione dell'endpoint privato. |
MHSMPrivateLinkServiceConnectionState
Oggetto che rappresenta lo stato di approvazione della connessione di collegamento privato.
| Nome | Tipo | Descrizione |
|---|---|---|
| actionsRequired |
Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer. |
|
| description |
string |
Motivo dell'approvazione o del rifiuto. |
| status |
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 hardware gestiti da una rete virtuale specifica.
| Nome | Tipo | Descrizione |
|---|---|---|
| id |
string |
ID risorsa completo di una subnet di 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 corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass.
| Valore | Descrizione |
|---|---|
| Allow | |
| Deny |
NetworkRuleBypassOptions
Indica il traffico che può ignorare le regole di rete. Può trattarsi di "AzureServices" o "None". Se non specificato, il valore predefinito è "AzureServices".
| Valore | Descrizione |
|---|---|
| AzureServices | |
| None |
PrivateEndpointConnectionProvisioningState
Stato di provisioning della connessione dell'endpoint privato.
| Valore | Descrizione |
|---|---|
| Succeeded | |
| Creating | |
| Updating | |
| Deleting | |
| Failed | |
| Disconnected |
PrivateEndpointServiceConnectionStatus
Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.
| Valore | Descrizione |
|---|---|
| Pending | |
| Approved | |
| Rejected | |
| Disconnected |
ProvisioningState
Stato del provisioning.
| Valore | Descrizione |
|---|---|
| Succeeded |
Il provisioning completo del pool di moduli di protezione hardware gestito è stato completato. |
| Provisioning |
È attualmente in corso il provisioning del pool di moduli di protezione hardware gestito. |
| Failed |
Il provisioning del pool di moduli di protezione hardware gestito non è riuscito. |
| Updating |
Il pool di moduli di protezione hardware gestito è attualmente in fase di aggiornamento. |
| Deleting |
Il pool di moduli di protezione hardware gestito è attualmente in fase di eliminazione. |
| Activated |
Il pool di moduli di protezione hardware gestito è pronto per l'uso normale. |
| SecurityDomainRestore |
Il pool di moduli di protezione hardware gestito è in attesa di un'azione di ripristino del dominio di sicurezza. |
| Restoring |
Il pool di moduli di protezione hardware gestito viene ripristinato dal backup completo del modulo di protezione hardware. |
PublicNetworkAccess
Controllare l'autorizzazione per il modulo di protezione hardware gestito dalle reti pubbliche.
| Valore | Descrizione |
|---|---|
| Enabled | |
| Disabled |
SystemData
Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi.
| Nome | Tipo | Descrizione |
|---|---|---|
| createdAt |
string (date-time) |
Timestamp della creazione della risorsa dell'insieme di credenziali delle chiavi (UTC). |
| createdBy |
string |
Identità che ha creato la risorsa dell'insieme di credenziali delle chiavi. |
| createdByType |
Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi. |
|
| lastModifiedAt |
string (date-time) |
Timestamp dell'ultima modifica della risorsa dell'insieme di credenziali delle chiavi (UTC). |
| lastModifiedBy |
string |
Identità che ha modificato per ultima la risorsa dell'insieme di credenziali delle chiavi. |
| lastModifiedByType |
Tipo di identità che ha modificato per ultima la risorsa dell'insieme di credenziali delle chiavi. |
UserAssignedIdentity
Proprietà di identità assegnate dall'utente
| Nome | Tipo | Descrizione |
|---|---|---|
| clientId |
string (uuid) |
ID client dell'identità assegnata. |
| principalId |
string (uuid) |
ID entità dell'identità assegnata. |