Managed Hsms - List By Subscription

Tjänst:: Key Vault

API-version:: 2024-11-01

Liståtgärden hämtar information om de hanterade HSM-pooler som är associerade med prenumerationen.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs?api-version=2024-11-01

Med valfria parametrar:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs?$top={$top}&api-version=2024-11-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.
$top	query		integer (int32)	Maximalt antal resultat som ska returneras.

Svar

Name	Typ	Description
200 OK	ManagedHsmListResult	Hämta information om alla hanterade HSM-pooler i den angivna prenumerationen.
Other Status Codes	ManagedHsmError	Felsvaret som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List managed HSM Pools in a subscription

Exempelbegäran

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2024-11-01


/**
 * Samples for ManagedHsms List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/
     * ManagedHsm_ListBySubscription.json
     */
    /**
     * Sample code: List managed HSM Pools in a subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedHSMPoolsInASubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.vaults().manager().serviceClient().getManagedHsms().list(null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_list_by_subscription.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.list_by_subscription()
    for item in response:
        print(item)


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

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_ListBySubscription.json
func ExampleManagedHsmsClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkeyvault.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewManagedHsmsClient().NewListBySubscriptionPager(&armkeyvault.ManagedHsmsClientListBySubscriptionOptions{Top: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ManagedHsmListResult = armkeyvault.ManagedHsmListResult{
		// 	Value: []*armkeyvault.ManagedHsm{
		// 		{
		// 			Name: to.Ptr("hsm1"),
		// 			Type: to.Ptr("Microsoft.KeyVault/managedHSMs"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1"),
		// 			Location: to.Ptr("westus"),
		// 			SKU: &armkeyvault.ManagedHsmSKU{
		// 				Name: to.Ptr(armkeyvault.ManagedHsmSKUNameStandardB1),
		// 				Family: to.Ptr(armkeyvault.ManagedHsmSKUFamilyB),
		// 			},
		// 			Tags: map[string]*string{
		// 				"Dept": to.Ptr("hsm"),
		// 				"Environment": to.Ptr("dogfood"),
		// 			},
		// 			Properties: &armkeyvault.ManagedHsmProperties{
		// 				EnablePurgeProtection: to.Ptr(false),
		// 				EnableSoftDelete: to.Ptr(true),
		// 				HsmURI: to.Ptr("https://westus.hsm1.managedhsm.azure.net"),
		// 				InitialAdminObjectIDs: []*string{
		// 					to.Ptr("00000000-0000-0000-0000-000000000000")},
		// 					ProvisioningState: to.Ptr(armkeyvault.ProvisioningStateSucceeded),
		// 					SoftDeleteRetentionInDays: to.Ptr[int32](90),
		// 					StatusMessage: to.Ptr("ManagedHsm is functional."),
		// 					TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("hsm2"),
		// 				Type: to.Ptr("Microsoft.KeyVault/managedHSMs"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2"),
		// 				Location: to.Ptr("westus"),
		// 				SKU: &armkeyvault.ManagedHsmSKU{
		// 					Name: to.Ptr(armkeyvault.ManagedHsmSKUNameStandardB1),
		// 					Family: to.Ptr(armkeyvault.ManagedHsmSKUFamilyB),
		// 				},
		// 				Tags: map[string]*string{
		// 					"Dept": to.Ptr("hsm"),
		// 					"Environment": to.Ptr("production"),
		// 				},
		// 				Properties: &armkeyvault.ManagedHsmProperties{
		// 					EnablePurgeProtection: to.Ptr(false),
		// 					EnableSoftDelete: to.Ptr(true),
		// 					HsmURI: to.Ptr("https://westus.hsm2.managedhsm.azure.net"),
		// 					InitialAdminObjectIDs: []*string{
		// 						to.Ptr("00000000-0000-0000-0000-000000000000")},
		// 						ProvisioningState: to.Ptr(armkeyvault.ProvisioningStateSucceeded),
		// 						SoftDeleteRetentionInDays: to.Ptr[int32](90),
		// 						StatusMessage: to.Ptr("ManagedHsm is functional."),
		// 						TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { KeyVaultManagementClient } = require("@azure/arm-keyvault");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to The List operation gets information about the managed HSM Pools associated with the subscription.
 *
 * @summary The List operation gets information about the managed HSM Pools associated with the subscription.
 * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_ListBySubscription.json
 */
async function listManagedHsmPoolsInASubscription() {
  const subscriptionId =
    process.env["KEYVAULT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new KeyVaultManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.managedHsms.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.KeyVault.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.KeyVault;

// Generated from example definition: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_ListBySubscription.json
// this example is just showing the usage of "ManagedHsms_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ManagedHsmResource item in subscriptionResource.GetManagedHsmsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ManagedHsmData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "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"
      }
    },
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm2.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
      "name": "hsm2",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "production"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2024-11-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Definitioner

Name	Description
ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
ActivationStatus	Status för aktivering
CreateMode	Skapa-läget för att ange om resursen skapas eller återställs från en borttagen resurs.
Error	Felet på servern.
GeoReplicationRegionProvisioningState	Etableringstillstånd för den geo-replikerade regionen.
identityType	Den typ av identitet som skapade nyckelvalvsresursen.
ManagedHsm	Resursinformation med utökade detaljer.
ManagedHsmError	Felet är fel.
ManagedHsmListResult	Lista över hanterade HSM-pooler
ManagedHsmProperties	Egenskaper för den hanterade HSM-poolen
ManagedHSMSecurityDomainProperties	Egenskaperna för säkerhetsdomänen för den hanterade hsm:en.
ManagedHsmSku	SKU-information
ManagedHsmSkuFamily	SKU-familj för den hanterade HSM-poolen
ManagedHsmSkuName	SKU för den hanterade HSM-poolen
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
MHSMGeoReplicatedRegion	En region som den här hanterade HSM-poolen har utökats till.
MHSMIPRule	En regel som styr tillgängligheten för en hanterad HSM-pool från en specifik IP-adress eller ett visst IP-intervall.
MHSMNetworkRuleSet	En uppsättning regler som styr nätverkstillgängligheten för en hanterad hsm-pool.
MHSMPrivateEndpoint	Egenskaper för objekt för privat slutpunkt.
MHSMPrivateEndpointConnectionItem	Anslutningsobjekt för privat slutpunkt.
MHSMPrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.
MHSMVirtualNetworkRule	En regel som styr tillgängligheten för en hanterad hsm-pool från ett specifikt virtuellt nätverk.
NetworkRuleAction	Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.
NetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".
PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.
ProvisioningState	Etableringstillstånd.
PublicNetworkAccess	Kontrollera behörigheten till den hanterade HSM:en från offentliga nätverk.
SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

ActionsRequired

Uppräkning

Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.

Värde	Description
None

ActivationStatus

Uppräkning

Status för aktivering

Värde	Description
Active	Den hanterade HSM-poolen är aktiv.
NotActivated	Den hanterade HSM-poolen har ännu inte aktiverats.
Unknown	Ett okänt fel uppstod vid aktivering av hanterad hsm.
Failed	Det gick inte att aktivera hanterad hsm.

CreateMode

Uppräkning

Skapa-läget för att ange om resursen skapas eller återställs från en borttagen resurs.

Värde	Description
recover	Återställ den hanterade HSM-poolen från en mjukt borttagen resurs.
default	Skapa en ny hanterad HSM-pool. Det här är standardalternativet.

Error

Objekt

Felet på servern.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Det inre felet innehåller en mer specifik felkod.
message	string	Felmeddelandet.

GeoReplicationRegionProvisioningState

Uppräkning

Etableringstillstånd för den geo-replikerade regionen.

Värde	Description
Preprovisioning
Provisioning
Succeeded
Failed
Deleting
Cleanup

identityType

Uppräkning

Den typ av identitet som skapade nyckelvalvsresursen.

Värde	Description
User
Application
ManagedIdentity
Key

ManagedHsm

Objekt

Resursinformation med utökade detaljer.

Name	Typ	Description
id	string	Azure Resource Manager resurs-ID för den hanterade HSM-poolen.
identity	ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
location	string	Den Azure-plats som stöds där den hanterade HSM-poolen ska skapas.
name	string	Namnet på den hanterade HSM-poolen.
properties	ManagedHsmProperties	Egenskaper för den hanterade HSM
sku	ManagedHsmSku	SKU-information
systemData	SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.
tags	object	Resursetiketter
type	string	Resurstypen för den hanterade HSM-poolen.

ManagedHsmError

Objekt

Felet är fel.

Name	Typ	Description
error	Error	Felet på servern.

ManagedHsmListResult

Objekt

Lista över hanterade HSM-pooler

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning hanterade HSM-pooler.
value	ManagedHsm[]	Listan över hanterade HSM-pooler.

ManagedHsmProperties

Objekt

Egenskaper för den hanterade HSM-poolen

Name	Typ	Standardvärde	Description
createMode	CreateMode		Skapa-läget för att ange om resursen skapas eller återställs från en borttagen resurs.
enablePurgeProtection	boolean	True	Egenskap som anger om skydd mot rensning är aktiverat för den här hanterade HSM-poolen. Om du anger den här egenskapen till true aktiveras skydd mot rensning för den här hanterade HSM-poolen och dess innehåll. Endast den hanterade HSM-tjänsten kan initiera en hård, oåterkallelig borttagning. Det går inte att ångra aktiveringen av den här funktionen.
enableSoftDelete	boolean	True	Egenskap för att ange om funktionen "mjuk borttagning" är aktiverad för den här hanterade HSM-poolen. Mjuk borttagning är aktiverat som standard för alla hanterade HSM:er och är oföränderlig.
hsmUri	string		URI:n för den hanterade hsm-poolen för att utföra åtgärder på nycklar.
initialAdminObjectIds	string[]		Matris med initiala objekt-ID:er för administratörer för den här hanterade HSM-poolen.
networkAcls	MHSMNetworkRuleSet		Regler som styr åtkomsten till nyckelvalvet från specifika nätverksplatser.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Lista över privata slutpunktsanslutningar som är associerade med den hanterade hsm-poolen.
provisioningState	ProvisioningState		Etableringstillstånd.
publicNetworkAccess	PublicNetworkAccess	Enabled	Kontrollera behörigheten till den hanterade HSM:en från offentliga nätverk.
regions	MHSMGeoReplicatedRegion[]		Lista över alla regioner som är associerade med den hanterade hsm-poolen.
scheduledPurgeDate	string (date-time)		Det schemalagda rensningsdatumet i UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Egenskaper för hanterad HSM-säkerhetsdomän.
softDeleteRetentionInDays	integer (int32)	90	Mjukt borttagna datakvarhållningsdagar. När du tar bort en HSM eller en nyckel förblir den återställningsbar för den konfigurerade kvarhållningsperioden eller under en standardperiod på 90 dagar. Den accepterar värden mellan 7 och 90.
statusMessage	string		Meddelande om resursstatus.
tenantId	string (uuid)		Det Azure Active Directory-klient-ID som ska användas för att autentisera begäranden till den hanterade HSM-poolen.

ManagedHSMSecurityDomainProperties

Objekt

Egenskaperna för säkerhetsdomänen för den hanterade hsm:en.

Name	Typ	Description
activationStatus	ActivationStatus	Status för aktivering
activationStatusMessage	string	Meddelande om aktiveringsstatus.

ManagedHsmSku

Objekt

SKU-information

Name	Typ	Description
family	ManagedHsmSkuFamily	SKU-familj för den hanterade HSM-poolen
name	ManagedHsmSkuName	SKU för den hanterade HSM-poolen

ManagedHsmSkuFamily

Uppräkning

SKU-familj för den hanterade HSM-poolen

Värde	Description
B
C

ManagedHsmSkuName

Uppräkning

SKU för den hanterade HSM-poolen

Värde	Description
Standard_B1
Custom_B32
Custom_B6
Custom_C42
Custom_C10

ManagedServiceIdentity

Objekt

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Uppräkning

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MHSMGeoReplicatedRegion

Objekt

En region som den här hanterade HSM-poolen har utökats till.

Name	Typ	Description
isPrimary	boolean	Ett booleskt värde som anger om regionen är den primära regionen eller en sekundär region.
name	string	Namnet på den geo-replikerade regionen.
provisioningState	GeoReplicationRegionProvisioningState	Etableringstillstånd för den geo-replikerade regionen.

MHSMIPRule

Objekt

En regel som styr tillgängligheten för en hanterad HSM-pool från en specifik IP-adress eller ett visst IP-intervall.

Name	Typ	Description
value	string	Ett IPv4-adressintervall i CIDR-notation, till exempel "124.56.78.91" (enkel IP-adress) eller "124.56.78.0/24" (alla adresser som börjar med 124.56.78).

MHSMNetworkRuleSet

Objekt

En uppsättning regler som styr nätverkstillgängligheten för en hanterad hsm-pool.

Name	Typ	Description
bypass	NetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".
defaultAction	NetworkRuleAction	Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.
ipRules	MHSMIPRule[]	Listan över IP-adressregler.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Listan över regler för virtuella nätverk.

MHSMPrivateEndpoint

Objekt

Egenskaper för objekt för privat slutpunkt.

Name	Typ	Description
id	string	Fullständig identifierare för den privata slutpunktsresursen.

MHSMPrivateEndpointConnectionItem

Objekt

Anslutningsobjekt för privat slutpunkt.

Name	Typ	Description
etag	string	Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.
id	string	ID för anslutning till privat slutpunkt.
properties.privateEndpoint	MHSMPrivateEndpoint	Egenskaper för det privata slutpunktsobjektet.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Godkännandetillstånd för den privata länkanslutningen.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.

MHSMPrivateLinkServiceConnectionState

Objekt

Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

Name	Typ	Description
actionsRequired	ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Anledningen till godkännande eller avvisande.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.

MHSMVirtualNetworkRule

Objekt

En regel som styr tillgängligheten för en hanterad hsm-pool från ett specifikt virtuellt nätverk.

Name	Typ	Description
id	string	Fullständigt resurs-ID för ett vnet-undernät, till exempel "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Uppräkning

Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.

Värde	Description
Allow
Deny

NetworkRuleBypassOptions

Uppräkning

Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".

Värde	Description
AzureServices
None

PrivateEndpointConnectionProvisioningState

Uppräkning

Etableringstillstånd för den privata slutpunktsanslutningen.

Värde	Description
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

Uppräkning

Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.

Värde	Description
Pending
Approved
Rejected
Disconnected

ProvisioningState

Uppräkning

Etableringstillstånd.

Värde	Description
Succeeded	Den hanterade HSM-poolen har etablerats fullständigt.
Provisioning	Den hanterade HSM-poolen håller för närvarande på att etableras.
Failed	Etableringen av den hanterade HSM-poolen misslyckades.
Updating	Den hanterade HSM-poolen uppdateras för närvarande.
Deleting	Den hanterade HSM-poolen håller för närvarande på att tas bort.
Activated	Den hanterade HSM-poolen är redo för normal användning.
SecurityDomainRestore	Den hanterade HSM-poolen väntar på en återställningsåtgärd för säkerhetsdomänen.
Restoring	Den hanterade HSM-poolen återställs från en fullständig HSM-säkerhetskopiering.

PublicNetworkAccess

Uppräkning

Kontrollera behörigheten till den hanterade HSM:en från offentliga nätverk.

Värde	Description
Enabled
Disabled

SystemData

Objekt

Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för att skapa nyckelvalvsresursen (UTC).
createdBy	string	Identiteten som skapade nyckelvalvsresursen.
createdByType	identityType	Den typ av identitet som skapade nyckelvalvsresursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för den senaste ändringen av nyckelvalvsresursen (UTC).
lastModifiedBy	string	Identiteten som senast ändrade nyckelvalvsresursen.
lastModifiedByType	identityType	Den typ av identitet som senast ändrade nyckelvalvsresursen.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.