Managed Hsms - Create Or Update

Odwołanie

Service:: Key Vault

API Version:: 2022-07-01

Utwórz lub zaktualizuj zarządzaną pulę modułów HSM w określonej subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa zarządzanej puli modułów HSM
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zarządzaną pulę modułów HSM.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
location	string	Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM.
properties	ManagedHsmProperties	Właściwości zarządzanego modułu HSM
sku	ManagedHsmSku	Szczegóły jednostki SKU
tags	object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagedHsm	Utworzona lub zaktualizowana zarządzana pula modułów HSM
202 Accepted	ManagedHsm	Zaakceptowane i operacja zostanie ukończona asynchronicznie. Headers Location: string
Other Status Codes	ManagedHsmError	Odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

ManagedHsm

Utworzona lub zaktualizowana zarządzana pula modułów HSM

202 Accepted

ManagedHsm

Zaakceptowane i operacja zostanie ukończona asynchronicznie.

Headers

Location: string

Other Status Codes

ManagedHsmError

Odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.
ActivationStatus	Stan aktywacji
CreateMode	Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.
Error	Błąd serwera.
identityType	Typ tożsamości, która utworzyła zasób magazynu kluczy.
ManagedHsm	Informacje o zasobach z rozszerzonymi szczegółami.
ManagedHsmError	Wyjątek błędu.
ManagedHsmProperties	Właściwości zarządzanej puli modułów HSM
ManagedHSMSecurityDomainProperties	Właściwości domeny zabezpieczeń zarządzanego modułu hsm.
ManagedHsmSku	Szczegóły jednostki SKU
ManagedHsmSkuFamily	Rodzina jednostek SKU zarządzanej puli modułów HSM
ManagedHsmSkuName	Jednostka SKU zarządzanej puli modułów HSM
MHSMIPRule	Reguła dotycząca ułatwień dostępu zarządzanej puli modułów HSM z określonego adresu IP lub zakresu adresów IP.
MHSMNetworkRuleSet	Zestaw reguł określających dostępność sieci zarządzanej puli modułów hsm.
MHSMPrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
MHSMPrivateEndpointConnectionItem	Element połączenia prywatnego punktu końcowego.
MHSMPrivateLinkServiceConnectionState	Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.
MHSMVirtualNetworkRule	Reguła dotycząca ułatwień dostępu zarządzanej puli modułów HSM z określonej sieci wirtualnej.
NetworkRuleAction	Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia.
NetworkRuleBypassOptions	Informuje, jaki ruch może pominąć reguły sieci. Może to być wartość "AzureServices" lub "None". Jeśli nie określono wartości domyślnej, to "AzureServices".
PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.
ProvisioningState	Stan aprowizacji.
PublicNetworkAccess	Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

Nazwa	Typ	Opis
None	string

ActivationStatus

Stan aktywacji

Nazwa	Typ	Opis
Active	string	Zarządzana pula modułów HSM jest aktywna.
Failed	string	Nie można aktywować zarządzanego modułu hsm.
NotActivated	string	Zarządzana pula modułów HSM nie została jeszcze aktywowana.
Unknown	string	Wystąpił nieznany błąd podczas aktywowania zarządzanego modułu hsm.

CreateMode

Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.

Nazwa	Typ	Opis
default	string	Utwórz nową zarządzaną pulę modułów HSM. Jest to domyślne ustawienie opcji.
recover	string	Odzyskaj zarządzaną pulę modułów HSM z nietrwałego zasobu.

Error

Błąd serwera.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Wewnętrzny błąd zawiera bardziej szczegółowy kod błędu.
message	string	Komunikat o błędzie.

identityType

Typ tożsamości, która utworzyła zasób magazynu kluczy.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Informacje o zasobach z rozszerzonymi szczegółami.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi Azure Resource Manager dla zarządzanej puli modułów HSM.
location	string	Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM.
name	string	Nazwa zarządzanej puli modułów HSM.
properties	ManagedHsmProperties	Właściwości zarządzanego modułu HSM
sku	ManagedHsmSku	Szczegóły jednostki SKU
systemData	SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.
tags	object	Tagi zasobów
type	string	Typ zasobu zarządzanej puli modułów HSM.

ManagedHsmError

Wyjątek błędu.

Nazwa	Typ	Opis
error	Error	Błąd serwera.

ManagedHsmProperties

Właściwości zarządzanej puli modułów HSM

Nazwa	Typ	Wartość domyślna	Opis
createMode	CreateMode		Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.
enablePurgeProtection	boolean	True	Właściwość określająca, czy ochrona przed przeczyszczeniem jest włączona dla tej zarządzanej puli modułów HSM. Ustawienie tej właściwości na wartość true aktywuje ochronę przed przeczyszczeniem dla tej zarządzanej puli modułów HSM i jej zawartości — tylko zarządzana usługa HSM może zainicjować twarde, nieodzyskiwalne usunięcie. Włączenie tej funkcji jest nieodwracalne.
enableSoftDelete	boolean	True	Właściwość określająca, czy dla tej zarządzanej puli modułów HSM włączono funkcję usuwania nietrwałego. Usuwanie nietrwałe jest domyślnie włączone dla wszystkich zarządzanych modułów HSM i jest niezmienne.
hsmUri	string		Identyfikator URI zarządzanej puli modułów hsm do wykonywania operacji na kluczach.
initialAdminObjectIds	string[]		Tablica początkowych identyfikatorów obiektów administratorów dla tej zarządzanej puli hsm.
networkAcls	MHSMNetworkRuleSet		Reguły dotyczące ułatwień dostępu magazynu kluczy z określonych lokalizacji sieciowych.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Lista połączeń prywatnego punktu końcowego skojarzonych z zarządzaną pulą modułów HSM.
provisioningState	ProvisioningState		Stan aprowizacji.
publicNetworkAccess	PublicNetworkAccess	Enabled	Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych.
scheduledPurgeDate	string		Zaplanowana data przeczyszczania w formacie UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Właściwości domeny zabezpieczeń zarządzanego modułu HSM.
softDeleteRetentionInDays	integer	90	Nietrwałe usunięte dni przechowywania danych. Usunięcie modułu HSM lub klucza pozostanie możliwe do odzyskania przez skonfigurowany okres przechowywania lub domyślny okres 90 dni. Akceptuje wartości z zakresu od 7 do 90.
statusMessage	string		Komunikat o stanie zasobu.
tenantId	string		Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań do zarządzanej puli modułów HSM.

ManagedHSMSecurityDomainProperties

Właściwości domeny zabezpieczeń zarządzanego modułu hsm.

Nazwa	Typ	Opis
activationStatus	ActivationStatus	Stan aktywacji
activationStatusMessage	string	Komunikat o stanie aktywacji.

ManagedHsmSku

Szczegóły jednostki SKU

Nazwa	Typ	Opis
family	ManagedHsmSkuFamily	Rodzina jednostek SKU zarządzanej puli modułów HSM
name	ManagedHsmSkuName	Jednostka SKU zarządzanej puli modułów HSM

ManagedHsmSkuFamily

Rodzina jednostek SKU zarządzanej puli modułów HSM

Nazwa	Typ	Opis
B	string

ManagedHsmSkuName

Jednostka SKU zarządzanej puli modułów HSM

Nazwa	Typ	Opis
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Reguła dotycząca ułatwień dostępu zarządzanej puli modułów HSM z określonego adresu IP lub zakresu adresów IP.

Nazwa	Typ	Opis
value	string	Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78).

MHSMNetworkRuleSet

Zestaw reguł określających dostępność sieci zarządzanej puli modułów hsm.

Nazwa	Typ	Opis
bypass	NetworkRuleBypassOptions	Informuje, jaki ruch może pominąć reguły sieci. Może to być wartość "AzureServices" lub "None". Jeśli nie określono wartości domyślnej, to "AzureServices".
defaultAction	NetworkRuleAction	Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia.
ipRules	MHSMIPRule[]	Lista reguł adresów IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Lista reguł sieci wirtualnej.

MHSMPrivateEndpoint

Właściwości obiektu prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu prywatnego punktu końcowego.

MHSMPrivateEndpointConnectionItem

Element połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
etag	string	Zmodyfikowane za każdym razem, gdy wystąpi zmiana stanu połączenia prywatnego punktu końcowego.
id	string	Identyfikator połączenia prywatnego punktu końcowego.
properties.privateEndpoint	MHSMPrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Stan zatwierdzenia połączenia z łączem prywatnym.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.

MHSMPrivateLinkServiceConnectionState

Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

Nazwa	Typ	Opis
actionsRequired	ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.
description	string	Przyczyna zatwierdzenia lub odrzucenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

MHSMVirtualNetworkRule

Reguła dotycząca ułatwień dostępu zarządzanej puli modułów HSM z określonej sieci wirtualnej.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia.

Nazwa	Typ	Opis
Allow	string
Deny	string

NetworkRuleBypassOptions

Informuje, jaki ruch może pominąć reguły sieci. Może to być wartość "AzureServices" lub "None". Jeśli nie określono wartości domyślnej, to "AzureServices".

Nazwa	Typ	Opis
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Stan aprowizacji.

Nazwa	Typ	Opis
Activated	string	Zarządzana pula modułów HSM jest gotowa do normalnego użycia.
Deleting	string	Zarządzana pula modułów HSM jest obecnie usuwana.
Failed	string	Aprowizowanie zarządzanej puli modułów HSM nie powiodło się.
Provisioning	string	Zarządzana pula modułów HSM jest obecnie aprowizowana.
Restoring	string	Zarządzana pula modułów HSM jest przywracana z pełnej kopii zapasowej modułu HSM.
SecurityDomainRestore	string	Zarządzana pula modułów HSM oczekuje na akcję przywracania domeny zabezpieczeń.
Succeeded	string	Zarządzana pula modułów HSM została w pełni aprowizowana.
Updating	string	Zarządzana pula modułów HSM jest obecnie aktualizowana.

PublicNetworkAccess

Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów magazynu kluczy (UTC).
createdBy	string	Tożsamość, która utworzyła zasób magazynu kluczy.
createdByType	identityType	Typ tożsamości, która utworzyła zasób magazynu kluczy.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu magazynu kluczy (UTC).
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób magazynu kluczy.
lastModifiedByType	identityType	Typ tożsamości, która ostatnio zmodyfikowała zasób magazynu kluczy.

Managed Hsms - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

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

Sample Request

Sample Response

Definicje

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

Dodatkowe zasoby