Managed Hsms - Create Or Update

Referens

Service:: Key Vault

API Version:: 2022-07-01

Skapa eller uppdatera en hanterad HSM-pool i den angivna prenumerationen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namnet på den hanterade HSM-poolen
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller den hanterade HSM-poolen.
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.

Begärandetext

Name	Typ	Description
location	string	Den Azure-plats som stöds där den hanterade HSM-poolen ska skapas.
properties	ManagedHsmProperties	Egenskaper för den hanterade HSM
sku	ManagedHsmSku	SKU-information
tags	object	Resurstaggar

Svar

Name	Typ	Description
200 OK	ManagedHsm	Skapad eller uppdaterad hanterad HSM-pool
202 Accepted	ManagedHsm	Accepterad och åtgärden slutförs asynkront. Headers Location: string
Other Status Codes	ManagedHsmError	Felsvaret som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

ManagedHsm

Skapad eller uppdaterad hanterad HSM-pool

202 Accepted

ManagedHsm

Accepterad och åtgärden slutförs asynkront.

Headers

Location: string

Other Status Codes

ManagedHsmError

Felsvaret som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create a new managed HSM Pool or update an existing managed HSM Pool

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": true,
    "softDeleteRetentionInDays": 90,
    "enablePurgeProtection": false
  },
  "location": "westus",
  "sku": {
    "family": "B",
    "name": "Standard_B1"
  },
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood"
  }
}

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_create_or_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_create_or_update(
        resource_group_name="hsm-group",
        name="hsm1",
        parameters={
            "location": "westus",
            "properties": {
                "enablePurgeProtection": False,
                "enableSoftDelete": True,
                "initialAdminObjectIds": ["00000000-0000-0000-0000-000000000000"],
                "softDeleteRetentionInDays": 90,
                "tenantId": "00000000-0000-0000-0000-000000000000",
            },
            "sku": {"family": "B", "name": "Standard_B1"},
            "tags": {"Dept": "hsm", "Environment": "dogfood"},
        },
    ).result()
    print(response)


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

Sample Response

Status code:: 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

Response Body

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": true,
    "softDeleteRetentionInDays": 90,
    "enablePurgeProtection": false,
    "hsmUri": null,
    "provisioningState": "Provisioning",
    "statusMessage": "Allocating hardware"
  },
  "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"
  }
}

Status code:: 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"
  }
}

Definitioner

Name	Description
ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.
ActivationStatus	Aktiveringsstatus
CreateMode	Skapandeläget för att ange om resursen skapas eller återställs från en borttagen resurs.
Error	Serverfelet.
identityType	Den typ av identitet som skapade nyckelvalvsresursen.
ManagedHsm	Resursinformation med utökad information.
ManagedHsmError	Felfelsfelet.
ManagedHsmProperties	Egenskaper för den hanterade HSM-poolen
ManagedHSMSecurityDomainProperties	Säkerhetsdomänegenskaperna för managed hsm.
ManagedHsmSku	SKU-information
ManagedHsmSkuFamily	SKU-familjen för den hanterade HSM-poolen
ManagedHsmSkuName	SKU för den hanterade HSM-poolen
MHSMIPRule	En regel som styr tillgängligheten för en hanterad hsm-pool från en specifik IP-adress eller ip-adressintervall.
MHSMNetworkRuleSet	En uppsättning regler som styr nätverkstillgängligheten för en hanterad hsm-pool.
MHSMPrivateEndpoint	Egenskaper för privat slutpunktsobjekt.
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 när egenskapen bypass har utvärderats.
NetworkRuleBypassOptions	Anger vilken trafik som kan kringgå nätverksregler. Detta kan vara "AzureServices" eller "None". Om inget 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.

ActionsRequired

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

Name	Typ	Description
None	string

ActivationStatus

Aktiveringsstatus

Name	Typ	Description
Active	string	Den hanterade HSM-poolen är aktiv.
Failed	string	Det gick inte att aktivera hanterad hsm.
NotActivated	string	Den hanterade HSM-poolen är inte aktiverad ännu.
Unknown	string	Ett okänt fel uppstod när managed hsm aktiverades.

CreateMode

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

Name	Typ	Description
default	string	Skapa en ny hanterad HSM-pool. Det här är standardalternativet.
recover	string	Återställa den hanterade HSM-poolen från en mjukt borttagen resurs.

Error

Serverfelet.

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

identityType

Den typ av identitet som skapade nyckelvalvsresursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Resursinformation med utökad information.

Name	Typ	Description
id	string	Resurs-ID för Azure Resource Manager för den hanterade HSM-poolen.
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:en
sku	ManagedHsmSku	SKU-information
systemData	SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.
tags	object	Resurstaggar
type	string	Resurstypen för den hanterade HSM-poolen.

ManagedHsmError

Felfelsfelet.

Name	Typ	Description
error	Error	Serverfelet.

ManagedHsmProperties

Egenskaper för den hanterade HSM-poolen

Name	Typ	Standardvärde	Description
createMode	CreateMode		Skapandelä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 den här egenskapen anges till true aktiveras skydd mot rensning för den här hanterade HSM-poolen och dess innehåll – endast Managed HSM-tjänsten kan initiera en hård och oåterkallelig borttagning. Det går inte att ångra aktiveringen av den här funktionen.
enableSoftDelete	boolean	True	Egenskap som anger 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 kan inte ändras.
hsmUri	string		URI för den hanterade hsm-poolen för att utföra åtgärder på nycklar.
initialAdminObjectIds	string[]		Matris med inledande objekt-ID:t 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.
scheduledPurgeDate	string		Det schemalagda rensningsdatumet i UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Egenskaper för managed HSM-säkerhetsdomäner.
softDeleteRetentionInDays	integer	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		Resursstatusmeddelande.
tenantId	string		Det Azure Active Directory-klientorganisations-ID som ska användas för att autentisera begäranden till den hanterade HSM-poolen.

ManagedHSMSecurityDomainProperties

Säkerhetsdomänegenskaperna för managed hsm.

Name	Typ	Description
activationStatus	ActivationStatus	Aktiveringsstatus
activationStatusMessage	string	Statusmeddelande för aktivering.

ManagedHsmSku

SKU-information

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

ManagedHsmSkuFamily

SKU-familjen för den hanterade HSM-poolen

Name	Typ	Description
B	string

ManagedHsmSkuName

SKU för den hanterade HSM-poolen

Name	Typ	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

En regel som styr tillgängligheten för en hanterad hsm-pool från en specifik IP-adress eller ip-adressintervall.

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

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

Name	Typ	Description
bypass	NetworkRuleBypassOptions	Anger vilken trafik som kan kringgå nätverksregler. Detta kan vara "AzureServices" eller "None". Om inget 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 när egenskapen bypass har utvärderats.
ipRules	MHSMIPRule[]	Listan över IP-adressregler.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Listan över regler för virtuella nätverk.

MHSMPrivateEndpoint

Egenskaper för privat slutpunktsobjekt.

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

MHSMPrivateEndpointConnectionItem

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 privat slutpunktsanslutning.
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

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

Name	Typ	Description
actionsRequired	ActionsRequired	Ett meddelande som anger om ändringar i tjänstleverantören kräver 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

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

Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast när egenskapen bypass har utvärderats.

Name	Typ	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Anger vilken trafik som kan kringgå nätverksregler. Detta kan vara "AzureServices" eller "None". Om inget anges är standardvärdet "AzureServices".

Name	Typ	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

Name	Typ	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

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

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Etableringstillstånd.

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

PublicNetworkAccess

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

Name	Typ	Description
Disabled	string
Enabled	string

SystemData

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

Name	Typ	Description
createdAt	string	Tidsstämpeln för att skapa nyckelvalvets resurs (UTC).
createdBy	string	Identiteten som skapade nyckelvalvsresursen.
createdByType	identityType	Den typ av identitet som skapade nyckelvalvsresursen.
lastModifiedAt	string	Tidsstämpeln för nyckelvalvsresursens senaste ändring (UTC).
lastModifiedBy	string	Identiteten som senast ändrade nyckelvalvsresursen.
lastModifiedByType	identityType	Den typ av identitet som senast ändrade nyckelvalvsresursen.

Managed Hsms - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Scopes

Exempel

Create a new managed HSM Pool or update an existing managed HSM Pool

Sample Request

Sample Response

Definitioner

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

Ytterligare resurser