Managed Hsms - Update

Başvuru

Hizmet:: Key Vault

API Sürümü:: 2022-07-01

Belirtilen abonelikte yönetilen bir HSM Havuzunu güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
name	path	True	string	Yönetilen HSM Havuzunun adı
resourceGroupName	path	True	string	Yönetilen HSM havuzunu içeren kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci Api Sürümü.

İstek Gövdesi

Name	Tür	Description
location	string	Yönetilen HSM Havuzunun oluşturulması gereken desteklenen Azure konumu.
properties	ManagedHsmProperties	Yönetilen HSM'nin özellikleri
sku	ManagedHsmSku	SKU ayrıntıları
tags	object	Kaynak etiketleri

Yanıtlar

Name	Tür	Description
200 OK	ManagedHsm	Düzeltme eki uygulamalı yönetilen HSM Havuzu
202 Accepted	ManagedHsm	Kabul edilir ve işlem zaman uyumsuz olarak tamamlanır. Üst Bilgiler Location: string
Other Status Codes	ManagedHsmError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

ManagedHsm

Düzeltme eki uygulamalı yönetilen HSM Havuzu

202 Accepted

ManagedHsm

Kabul edilir ve işlem zaman uyumsuz olarak tamamlanır.

Üst Bilgiler

Location: string

Other Status Codes

ManagedHsmError

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Örnek yanıt

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

Durum kodu:: 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

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

Tanımlar

Name	Description
ActionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
ActivationStatus	Etkinleştirme Durumu
CreateMode	Kaynağın oluşturulduğunu veya silinmiş bir kaynaktan kurtarıldığını belirten oluşturma modu.
Error	Sunucu hatası.
identityType	Anahtar kasası kaynağını oluşturan kimliğin türü.
ManagedHsm	Genişletilmiş ayrıntıları içeren kaynak bilgileri.
ManagedHsmError	Hata özel durumu.
ManagedHsmProperties	Yönetilen HSM Havuzunun Özellikleri
ManagedHSMSecurityDomainProperties	Yönetilen hsm'nin güvenlik etki alanı özellikleri.
ManagedHsmSku	SKU ayrıntıları
ManagedHsmSkuFamily	Yönetilen HSM Havuzunun SKU Ailesi
ManagedHsmSkuName	Yönetilen HSM Havuzunun SKU'su
MHSMIPRule	Belirli bir ip adresinden veya ip aralığından yönetilen hsm havuzunun erişilebilirliğini yöneten kural.
MHSMNetworkRuleSet	Yönetilen bir hsm havuzunun ağ erişilebilirliğini yöneten kurallar kümesi.
MHSMPrivateEndpoint	Özel uç nokta nesne özellikleri.
MHSMPrivateEndpointConnectionItem	Özel uç nokta bağlantı öğesi.
MHSMPrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumunu temsil eden nesne.
MHSMVirtualNetworkRule	Belirli bir sanal ağdan yönetilen hsm havuzunun erişilebilirliğini yöneten kural.
NetworkRuleAction	IpRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca bypass özelliği değerlendirildikten sonra kullanılır.
NetworkRuleBypassOptions	Ağ kurallarını hangi trafiğin atlayabileceğinizi bildirir. Bu ,'AzureServices' veya 'None' olabilir. Belirtilmezse varsayılan değer 'AzureServices' olur.
PrivateEndpointConnectionProvisioningState	Özel uç nokta bağlantısının sağlama durumu.
PrivateEndpointServiceConnectionStatus	Bağlantının anahtar kasası sahibi tarafından onaylandığını, reddedildiğini veya kaldırıldığını gösterir.
ProvisioningState	Sağlama durumu.
PublicNetworkAccess	Genel ağlardan yönetilen HSM'ye yönelik izni denetleme.
SystemData	Anahtar kasası kaynağının oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

ActionsRequired

Listeleme

Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.

Değer	Description
None

ActivationStatus

Listeleme

Etkinleştirme Durumu

Değer	Description
Active	Yönetilen HSM Havuzu etkindir.
Failed	Yönetilen hsm etkinleştirilemedi.
NotActivated	Yönetilen HSM Havuzu henüz etkinleştirilmedi.
Unknown	Yönetilen hsm etkinleştirilirken bilinmeyen bir hata oluştu.

CreateMode

Listeleme

Kaynağın oluşturulduğunu veya silinmiş bir kaynaktan kurtarıldığını belirten oluşturma modu.

Değer	Description
default	Yeni bir yönetilen HSM havuzu oluşturun. Bu varsayılan seçenektir.
recover	Yönetilen HSM havuzunu geçici olarak silinen bir kaynaktan kurtarın.

Error

Object

Sunucu hatası.

Name	Tür	Description
code	string	Hata kodu.
innererror	Error	İç hata, daha belirgin bir hata kodu içerir.
message	string	Hata iletisi.

identityType

Listeleme

Anahtar kasası kaynağını oluşturan kimliğin türü.

Değer	Description
Application
Key
ManagedIdentity
User

ManagedHsm

Object

Genişletilmiş ayrıntıları içeren kaynak bilgileri.

Name	Tür	Description
id	string	Yönetilen HSM Havuzu için Azure Resource Manager kaynak kimliği.
location	string	Yönetilen HSM Havuzunun oluşturulması gereken desteklenen Azure konumu.
name	string	Yönetilen HSM Havuzunun adı.
properties	ManagedHsmProperties	Yönetilen HSM'nin özellikleri
sku	ManagedHsmSku	SKU ayrıntıları
systemData	SystemData	Anahtar kasası kaynağının oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak etiketleri
type	string	Yönetilen HSM Havuzunun kaynak türü.

ManagedHsmError

Object

Hata özel durumu.

Name	Tür	Description
error	Error	Sunucu hatası.

ManagedHsmProperties

Object

Yönetilen HSM Havuzunun Özellikleri

Name	Tür	Default value	Description
createMode	CreateMode		Kaynağın oluşturulduğunu veya silinmiş bir kaynaktan kurtarıldığını belirten oluşturma modu.
enablePurgeProtection	boolean	True	Bu yönetilen HSM havuzu için temizlemeye karşı korumanın etkinleştirilip etkinleştirilmediğini belirten özellik. Bu özelliğin true olarak ayarlanması, bu yönetilen HSM havuzu ve içeriği için temizlemeye karşı korumayı etkinleştirir. Yalnızca Yönetilen HSM hizmeti sabit, kurtarılamaz bir silme işlemi başlatabilir. Bu işlevin etkinleştirilmesi geri alınamaz.
enableSoftDelete	boolean	True	Bu yönetilen HSM havuzu için 'geçici silme' işlevinin etkinleştirilip etkinleştirilmediğini belirten özellik. Geçici silme, tüm yönetilen HSM'ler için varsayılan olarak etkindir ve sabittir.
hsmUri	string		Anahtarlarda işlem gerçekleştirmek için yönetilen hsm havuzunun URI'si.
initialAdminObjectIds	string[]		Bu yönetilen hsm havuzu için ilk yöneticiler nesne kimlikleri dizisi.
networkAcls	MHSMNetworkRuleSet		Belirli ağ konumlarından anahtar kasasının erişilebilirliğini yöneten kurallar.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Yönetilen hsm havuzuyla ilişkili özel uç nokta bağlantılarının listesi.
provisioningState	ProvisioningState		Sağlama durumu.
publicNetworkAccess	PublicNetworkAccess	Enabled	Genel ağlardan yönetilen HSM'ye yönelik izni denetleme.
scheduledPurgeDate	string (date-time)		UTC olarak zamanlanan temizleme tarihi.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Yönetilen HSM güvenlik etki alanı özellikleri.
softDeleteRetentionInDays	integer (int32)	90	Geçici olarak silinen veri saklama günleri. Bir HSM'yi veya anahtarı sildiğinizde, yapılandırılan saklama süresi veya varsayılan 90 gün boyunca kurtarılabilir durumda kalır. 7 ile 90 arasındaki değerleri kabul eder.
statusMessage	string		Kaynak Durumu İletisi.
tenantId	string (uuid)		Yönetilen HSM havuzuna yönelik isteklerin kimliğini doğrulamak için kullanılması gereken Azure Active Directory kiracı kimliği.

ManagedHSMSecurityDomainProperties

Object

Yönetilen hsm'nin güvenlik etki alanı özellikleri.

Name	Tür	Description
activationStatus	ActivationStatus	Etkinleştirme Durumu
activationStatusMessage	string	Etkinleştirme Durum İletisi.

ManagedHsmSku

Object

SKU ayrıntıları

Name	Tür	Description
family	ManagedHsmSkuFamily	Yönetilen HSM Havuzunun SKU Ailesi
name	ManagedHsmSkuName	Yönetilen HSM Havuzunun SKU'su

ManagedHsmSkuFamily

Listeleme

Yönetilen HSM Havuzunun SKU Ailesi

Değer	Description
B

ManagedHsmSkuName

Listeleme

Yönetilen HSM Havuzunun SKU'su

Değer	Description
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Object

Belirli bir ip adresinden veya ip aralığından yönetilen hsm havuzunun erişilebilirliğini yöneten kural.

Name	Tür	Description
value	string	CIDR gösteriminde '124.56.78.91' (basit IP adresi) veya '124.56.78.0/24' gibi bir IPv4 adres aralığı (124.56.78 ile başlayan tüm adresler).

MHSMNetworkRuleSet

Object

Yönetilen bir hsm havuzunun ağ erişilebilirliğini yöneten kurallar kümesi.

Name	Tür	Description
bypass	NetworkRuleBypassOptions	Ağ kurallarını hangi trafiğin atlayabileceğinizi bildirir. Bu ,'AzureServices' veya 'None' olabilir. Belirtilmezse varsayılan değer 'AzureServices' olur.
defaultAction	NetworkRuleAction	IpRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca bypass özelliği değerlendirildikten sonra kullanılır.
ipRules	MHSMIPRule[]	IP adresi kuralları listesi.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Sanal ağ kurallarının listesi.

MHSMPrivateEndpoint

Object

Özel uç nokta nesne özellikleri.

Name	Tür	Description
id	string	Özel uç nokta kaynağının tam tanımlayıcısı.

MHSMPrivateEndpointConnectionItem

Object

Özel uç nokta bağlantı öğesi.

Name	Tür	Description
etag	string	Özel uç nokta bağlantısının durumunda bir değişiklik olduğunda değiştirilir.
id	string	Özel uç nokta bağlantısının kimliği.
properties.privateEndpoint	MHSMPrivateEndpoint	Özel uç nokta nesnesinin özellikleri.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumu.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Özel uç nokta bağlantısının sağlama durumu.

MHSMPrivateLinkServiceConnectionState

Object

Özel bağlantı bağlantısının onay durumunu temsil eden nesne.

Name	Tür	Description
actionsRequired	ActionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
description	string	Onay veya reddetme nedeni.
status	PrivateEndpointServiceConnectionStatus	Bağlantının anahtar kasası sahibi tarafından onaylandığını, reddedildiğini veya kaldırıldığını gösterir.

MHSMVirtualNetworkRule

Object

Belirli bir sanal ağdan yönetilen hsm havuzunun erişilebilirliğini yöneten kural.

Name	Tür	Description
id	string	'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' gibi bir sanal ağ alt ağının tam kaynak kimliği.

NetworkRuleAction

Listeleme

IpRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca bypass özelliği değerlendirildikten sonra kullanılır.

Değer	Description
Allow
Deny

NetworkRuleBypassOptions

Listeleme

Ağ kurallarını hangi trafiğin atlayabileceğinizi bildirir. Bu ,'AzureServices' veya 'None' olabilir. Belirtilmezse varsayılan değer 'AzureServices' olur.

Değer	Description
AzureServices
None

PrivateEndpointConnectionProvisioningState

Listeleme

Özel uç nokta bağlantısının sağlama durumu.

Değer	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Listeleme

Bağlantının anahtar kasası sahibi tarafından onaylandığını, reddedildiğini veya kaldırıldığını gösterir.

Değer	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Listeleme

Sağlama durumu.

Değer	Description
Activated	Yönetilen HSM havuzu normal kullanıma hazırdır.
Deleting	Yönetilen HSM Havuzu şu anda siliniyor.
Failed	Yönetilen HSM Havuzunun sağlanması başarısız oldu.
Provisioning	Yönetilen HSM Havuzu şu anda sağlanıyor.
Restoring	Yönetilen HSM havuzu tam HSM yedeklemesinden geri yükleniyor.
SecurityDomainRestore	Yönetilen HSM havuzu bir güvenlik etki alanı geri yükleme eylemini bekliyor.
Succeeded	Yönetilen HSM Havuzu tam olarak sağlanmıştır.
Updating	Yönetilen HSM Havuzu şu anda güncelleştiriliyor.

PublicNetworkAccess

Listeleme

Genel ağlardan yönetilen HSM'ye yönelik izni denetleme.

Değer	Description
Disabled
Enabled

SystemData

Object

Anahtar kasası kaynağının oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Anahtar kasası kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Anahtar kasası kaynağını oluşturan kimlik.
createdByType	identityType	Anahtar kasası kaynağını oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Anahtar kasası kaynağının son değişikliğinin (UTC) zaman damgası.
lastModifiedBy	string	Anahtar kasası kaynağını en son değiştiren kimlik.
lastModifiedByType	identityType	Anahtar kasası kaynağını son değiştiren kimlik türü.

AI Skills Fest

Aracılığıyla paylaş

Managed Hsms - Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

Update an existing managed HSM Pool

Örnek isteği

Örnek yanıt

Tanımlar

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

Ek kaynaklar