Managed Hsms - Update

Referentie

Service:: Key Vault

API Version:: 2022-07-01

Werk een beheerde HSM-pool bij in het opgegeven abonnement.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van de beheerde HSM-pool
resourceGroupName	path	True	string	Naam van de resourcegroep die de beheerde HSM-pool bevat.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
location	string	De ondersteunde Azure-locatie waar de beheerde HSM-pool moet worden gemaakt.
properties	ManagedHsmProperties	Eigenschappen van de beheerde HSM
sku	ManagedHsmSku	SKU-details
tags	object	Resourcetags

Antwoorden

Name	Type	Description
200 OK	ManagedHsm	Beheerde HSM-pool met patches
202 Accepted	ManagedHsm	Geaccepteerd en de bewerking wordt asynchroon voltooid. Headers Location: string
Other Status Codes	ManagedHsmError	Het foutantwoord waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

ManagedHsm

Beheerde HSM-pool met patches

202 Accepted

ManagedHsm

Geaccepteerd en de bewerking wordt asynchroon voltooid.

Headers

Location: string

Other Status Codes

ManagedHsmError

Het foutantwoord waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Sample Response

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

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

Definities

Name	Description
ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.
ActivationStatus	Activeringsstatus
CreateMode	De modus maken om aan te geven of de resource wordt gemaakt of wordt hersteld vanuit een verwijderde resource.
Error	De serverfout.
identityType	Het type identiteit waarmee de sleutelkluisresource is gemaakt.
ManagedHsm	Resourcegegevens met uitgebreide details.
ManagedHsmError	De fout-uitzondering.
ManagedHsmProperties	Eigenschappen van de beheerde HSM-pool
ManagedHSMSecurityDomainProperties	De eigenschappen van het beveiligingsdomein van de beheerde hsm.
ManagedHsmSku	SKU-details
ManagedHsmSkuFamily	SKU-familie van de beheerde HSM-pool
ManagedHsmSkuName	SKU van de beheerde HSM-pool
MHSMIPRule	Een regel die de toegankelijkheid van een beheerde hsm-pool vanaf een specifiek IP-adres of IP-bereik regelt.
MHSMNetworkRuleSet	Een set regels voor de netwerktoegankelijkheid van een beheerde hsm-pool.
MHSMPrivateEndpoint	Eigenschappen van privé-eindpuntobjecten.
MHSMPrivateEndpointConnectionItem	Privé-eindpuntverbindingsitem.
MHSMPrivateLinkServiceConnectionState	Een object dat de goedkeuringsstatus van de Private Link-verbinding vertegenwoordigt.
MHSMVirtualNetworkRule	Een regel voor de toegankelijkheid van een beheerde hsm-pool vanuit een specifiek virtueel netwerk.
NetworkRuleAction	De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomen. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.
NetworkRuleBypassOptions	Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde 'AzureServices'.
PrivateEndpointConnectionProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.
ProvisioningState	Inrichtingsstatus.
PublicNetworkAccess	Beheermachtigingen voor de beheerde HSM vanuit openbare netwerken.
SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.

ActionsRequired

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.

Name	Type	Description
None	string

ActivationStatus

Activeringsstatus

Name	Type	Description
Active	string	De beheerde HSM-pool is actief.
Failed	string	Kan beheerde hsm niet activeren.
NotActivated	string	De beheerde HSM-pool is nog niet geactiveerd.
Unknown	string	Er is een onbekende fout opgetreden tijdens het activeren van beheerde hsm.

CreateMode

De modus maken om aan te geven of de resource wordt gemaakt of wordt hersteld vanuit een verwijderde resource.

Name	Type	Description
default	string	Maak een nieuwe beheerde HSM-pool. Dit is de standaardoptie.
recover	string	Herstel de beheerde HSM-pool van een voorlopig verwijderde resource.

Error

De serverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De interne fout bevat een specifiekere foutcode.
message	string	Het foutbericht.

identityType

Het type identiteit waarmee de sleutelkluisresource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Resourcegegevens met uitgebreide details.

Name	Type	Description
id	string	De Azure Resource Manager resource-id voor de beheerde HSM-pool.
location	string	De ondersteunde Azure-locatie waar de beheerde HSM-pool moet worden gemaakt.
name	string	De naam van de beheerde HSM-pool.
properties	ManagedHsmProperties	Eigenschappen van de beheerde HSM
sku	ManagedHsmSku	SKU-details
systemData	SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.
tags	object	Resourcetags
type	string	Het resourcetype van de beheerde HSM-pool.

ManagedHsmError

De fout-uitzondering.

Name	Type	Description
error	Error	De serverfout.

ManagedHsmProperties

Eigenschappen van de beheerde HSM-pool

Name	Type	Standaardwaarde	Description
createMode	CreateMode		De modus maken om aan te geven of de resource wordt gemaakt of wordt hersteld vanuit een verwijderde resource.
enablePurgeProtection	boolean	True	Eigenschap die aangeeft of beveiliging tegen opschonen is ingeschakeld voor deze beheerde HSM-pool. Als u deze eigenschap instelt op true, activeert u beveiliging tegen opschonen voor deze beheerde HSM-pool en de bijbehorende inhoud. Alleen de beheerde HSM-service kan een harde, onherstelbare verwijdering initiëren. Het inschakelen van deze functionaliteit kan niet ongedaan worden gesteld.
enableSoftDelete	boolean	True	Eigenschap om op te geven of de functionaliteit 'voorlopig verwijderen' is ingeschakeld voor deze beheerde HSM-pool. Voorlopig verwijderen is standaard ingeschakeld voor alle beheerde HSM's en is onveranderbaar.
hsmUri	string		De URI van de beheerde hsm-pool voor het uitvoeren van bewerkingen op sleutels.
initialAdminObjectIds	string[]		Matrix met initiële beheerdersobject-id's voor deze beheerde hsm-pool.
networkAcls	MHSMNetworkRuleSet		Regels voor de toegankelijkheid van de sleutelkluis vanaf specifieke netwerklocaties.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan de beheerde hsm-pool.
provisioningState	ProvisioningState		Inrichtingsstatus.
publicNetworkAccess	PublicNetworkAccess	Enabled	Beheermachtigingen voor de beheerde HSM vanuit openbare netwerken.
scheduledPurgeDate	string		De geplande opschoondatum in UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Eigenschappen van beheerde HSM-beveiligingsdomeinen.
softDeleteRetentionInDays	integer	90	Voorlopig verwijderde gegevensretentiedagen. Wanneer u een HSM of een sleutel verwijdert, blijft deze herstelbaar voor de geconfigureerde bewaarperiode of voor een standaardperiode van 90 dagen. Het accepteert waarden tussen 7 en 90.
statusMessage	string		Resourcestatusbericht.
tenantId	string		De Tenant-id van Azure Active Directory die moet worden gebruikt voor het verifiëren van aanvragen voor de beheerde HSM-pool.

ManagedHSMSecurityDomainProperties

De eigenschappen van het beveiligingsdomein van de beheerde hsm.

Name	Type	Description
activationStatus	ActivationStatus	Activeringsstatus
activationStatusMessage	string	Activeringsstatusbericht.

ManagedHsmSku

SKU-details

Name	Type	Description
family	ManagedHsmSkuFamily	SKU-familie van de beheerde HSM-pool
name	ManagedHsmSkuName	SKU van de beheerde HSM-pool

ManagedHsmSkuFamily

SKU-familie van de beheerde HSM-pool

Name	Type	Description
B	string

ManagedHsmSkuName

SKU van de beheerde HSM-pool

Name	Type	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Een regel die de toegankelijkheid van een beheerde hsm-pool vanaf een specifiek IP-adres of IP-bereik regelt.

Name	Type	Description
value	string	Een IPv4-adresbereik in CIDR-notatie, zoals '124.56.78.91' (eenvoudig IP-adres) of '124.56.78.0/24' (alle adressen die beginnen met 124.56.78).

MHSMNetworkRuleSet

Een set regels voor de netwerktoegankelijkheid van een beheerde hsm-pool.

Name	Type	Description
bypass	NetworkRuleBypassOptions	Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde 'AzureServices'.
defaultAction	NetworkRuleAction	De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomen. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.
ipRules	MHSMIPRule[]	De lijst met IP-adresregels.
virtualNetworkRules	MHSMVirtualNetworkRule[]	De lijst met regels voor virtuele netwerken.

MHSMPrivateEndpoint

Eigenschappen van privé-eindpuntobjecten.

Name	Type	Description
id	string	Volledige id van de privé-eindpuntresource.

MHSMPrivateEndpointConnectionItem

Privé-eindpuntverbindingsitem.

Name	Type	Description
etag	string	Gewijzigd wanneer er een wijziging is in de status van de privé-eindpuntverbinding.
id	string	Id van privé-eindpuntverbinding.
properties.privateEndpoint	MHSMPrivateEndpoint	Eigenschappen van het privé-eindpuntobject.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Goedkeuringsstatus van de Private Link-verbinding.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.

MHSMPrivateLinkServiceConnectionState

Een object dat de goedkeuringsstatus van de Private Link-verbinding vertegenwoordigt.

Name	Type	Description
actionsRequired	ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring of afwijzing.
status	PrivateEndpointServiceConnectionStatus	Hiermee wordt aangegeven of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

MHSMVirtualNetworkRule

Een regel voor de toegankelijkheid van een beheerde hsm-pool vanuit een specifiek virtueel netwerk.

Name	Type	Description
id	string	Volledige resource-id van een vnet-subnet, zoals '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.

NetworkRuleAction

De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomen. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.

Name	Type	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde 'AzureServices'.

Name	Type	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

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

PrivateEndpointServiceConnectionStatus

Geeft aan of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Inrichtingsstatus.

Name	Type	Description
Activated	string	De beheerde HSM-pool is gereed voor normaal gebruik.
Deleting	string	De beheerde HSM-pool wordt momenteel verwijderd.
Failed	string	Het inrichten van de beheerde HSM-pool is mislukt.
Provisioning	string	De beheerde HSM-pool wordt momenteel ingericht.
Restoring	string	De beheerde HSM-pool wordt hersteld vanuit een volledige HSM-back-up.
SecurityDomainRestore	string	De beheerde HSM-pool wacht op een herstelactie voor het beveiligingsdomein.
Succeeded	string	De beheerde HSM-pool is volledig ingericht.
Updating	string	De beheerde HSM-pool wordt momenteel bijgewerkt.

PublicNetworkAccess

Beheermachtigingen voor de beheerde HSM vanuit openbare netwerken.

Name	Type	Description
Disabled	string
Enabled	string

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van de sleutelkluisresources (UTC).
createdBy	string	De identiteit waarmee de sleutelkluisresource is gemaakt.
createdByType	identityType	Het type identiteit waarmee de sleutelkluisresource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de sleutelkluisresource (UTC).
lastModifiedBy	string	De identiteit die de sleutelkluisresource het laatst heeft gewijzigd.
lastModifiedByType	identityType	Het type identiteit dat de sleutelkluisresource het laatst heeft gewijzigd.

Managed Hsms - Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

Update an existing managed HSM Pool

Sample Request

Sample Response

Definities

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

Aanvullende resources