Managed Hsms - Update

參考

Service:: Key Vault

API Version:: 2022-07-01

更新指定訂用帳戶中的受控 HSM 集區。

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

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	受控 HSM 集區的名稱
resourceGroupName	path	True	string	包含受控 HSM 集區的資源群組名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
location	string	應建立受控 HSM 集區的支援 Azure 位置。
properties	ManagedHsmProperties	受控 HSM 的屬性
sku	ManagedHsmSku	SKU 詳細資料
tags	object	資源標籤

回應

名稱	類型	Description
200 OK	ManagedHsm	修補的受控 HSM 集區
202 Accepted	ManagedHsm	已接受，且作業會以異步方式完成。 Headers Location: string
Other Status Codes	ManagedHsmError	描述作業失敗原因的錯誤回應。

名稱

類型

Description

200 OK

ManagedHsm

修補的受控 HSM 集區

202 Accepted

ManagedHsm

已接受，且作業會以異步方式完成。

Headers

Location: string

Other Status Codes

ManagedHsmError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

定義

名稱	Description
ActionsRequired	訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。
ActivationStatus	啟用狀態
CreateMode	建立模式，指出正在建立資源或正在從已刪除的資源復原。
Error	伺服器錯誤。
identityType	建立金鑰保存庫資源的身分識別類型。
ManagedHsm	具有擴充詳細數據的資源資訊。
ManagedHsmError	錯誤例外狀況。
ManagedHsmProperties	受控 HSM 集區的屬性
ManagedHSMSecurityDomainProperties	受控 hsm 的安全性網域屬性。
ManagedHsmSku	SKU 詳細資料
ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
ManagedHsmSkuName	受控 HSM 集區的 SKU
MHSMIPRule	規則，控管來自特定IP位址或IP範圍的受控 hsm 集區存取範圍。
MHSMNetworkRuleSet	一組規則，控管受控 hsm 集區的網路存取範圍。
MHSMPrivateEndpoint	私人端點對象屬性。
MHSMPrivateEndpointConnectionItem	私人端點連線專案。
MHSMPrivateLinkServiceConnectionState	物件，表示私人連結連線的核准狀態。
MHSMVirtualNetworkRule	規則，控管來自特定虛擬網路之受控 hsm 集區的存取範圍。
NetworkRuleAction	沒有來自ipRules和 virtualNetworkRules 的規則相符時的預設動作。這只有在評估略過屬性之後才會使用。
NetworkRuleBypassOptions	告知哪些流量可以略過網路規則。這可以是 'AzureServices' 或 'None'。如果未指定，則預設值為『AzureServices』。
PrivateEndpointConnectionProvisioningState	私人端點聯機的布建狀態。
PrivateEndpointServiceConnectionStatus	指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。
ProvisioningState	布建狀態。
PublicNetworkAccess	從公用網路控制受控 HSM 的許可權。
SystemData	關於建立和上次修改金鑰保存庫資源的元數據。

ActionsRequired

訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。

名稱	類型	Description
None	string

ActivationStatus

啟用狀態

名稱	類型	Description
Active	string	受控 HSM 集區作用中。
Failed	string	無法啟動受控 hsm。
NotActivated	string	尚未啟用受控 HSM 集區。
Unknown	string	啟動Managed hsm時發生未知的錯誤。

CreateMode

建立模式，指出正在建立資源或正在從已刪除的資源復原。

名稱	類型	Description
default	string	建立新的受控 HSM 集區。這是預設選項。
recover	string	從虛刪除的資源復原受控 HSM 集區。

Error

伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	內部錯誤包含更明確的錯誤碼。
message	string	錯誤訊息。

identityType

建立金鑰保存庫資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

具有擴充詳細數據的資源資訊。

名稱	類型	Description
id	string	受控 HSM 集區的 Azure Resource Manager 資源識別碼。
location	string	應該在其中建立受控 HSM 集區的受支援 Azure 位置。
name	string	受控 HSM 集區的名稱。
properties	ManagedHsmProperties	Managed HSM 的屬性
sku	ManagedHsmSku	SKU 詳細資料
systemData	SystemData	關於建立和上次修改金鑰保存庫資源的元數據。
tags	object	資源標籤
type	string	受控 HSM 集區的資源類型。

ManagedHsmError

錯誤例外狀況。

名稱	類型	Description
error	Error	伺服器錯誤。

ManagedHsmProperties

受控 HSM 集區的屬性

名稱	類型	預設值	Description
createMode	CreateMode		建立模式，指出正在建立資源或正在從已刪除的資源復原。
enablePurgeProtection	boolean	True	屬性，指定是否為此受控 HSM 集區啟用清除保護。將此屬性設定為 true 可啟用保護，以防止清除此受控 HSM 集區和其內容-只有受控 HSM 服務可能會起始硬式且無法復原的刪除。啟用這項功能無法復原。
enableSoftDelete	boolean	True	屬性，指定是否為此受控 HSM 集區啟用「虛刪除」功能。默認會針對所有受控 HSM 啟用虛刪除，而且是不可變的。
hsmUri	string		受控 hsm 集區的 URI，用於在金鑰上執行作業。
initialAdminObjectIds	string[]		這個受控 hsm 集區的初始系統管理員對象標識子陣列。
networkAcls	MHSMNetworkRuleSet		規則，控管來自特定網路位置之密鑰保存庫的存取範圍。
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		與受控 hsm 集區相關聯的私人端點連線清單。
provisioningState	ProvisioningState		布建狀態。
publicNetworkAccess	PublicNetworkAccess	Enabled	從公用網路控制受控 HSM 的許可權。
scheduledPurgeDate	string		UTC 的排程清除日期。
securityDomainProperties	ManagedHSMSecurityDomainProperties		受控 HSM 安全性網域屬性。
softDeleteRetentionInDays	integer	90	虛刪除的數據保留天數。當您刪除 HSM 或金鑰時，它會在設定的保留期間或預設的 90 天內保持可復原。它接受介於 7 到 90 之間的值。
statusMessage	string		資源狀態消息。
tenantId	string		應該用來向受控 HSM 集區驗證要求的 Azure Active Directory 租使用者標識碼。

ManagedHSMSecurityDomainProperties

受控 hsm 的安全性網域屬性。

名稱	類型	Description
activationStatus	ActivationStatus	啟用狀態
activationStatusMessage	string	啟用狀態消息。

ManagedHsmSku

SKU 詳細資料

名稱	類型	Description
family	ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
name	ManagedHsmSkuName	受控 HSM 集區的 SKU

ManagedHsmSkuFamily

受控 HSM 集區的 SKU 系列

名稱	類型	Description
B	string

ManagedHsmSkuName

受控 HSM 集區的 SKU

名稱	類型	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

規則，控管來自特定IP位址或IP範圍的受控 hsm 集區存取範圍。

名稱	類型	Description
value	string	CIDR 表示法中的 IPv4 位址範圍，例如 '124.56.78.91' (簡單 IP 位址) 或 '124.56.78.0/24' (開頭為 124.56.78 的所有地址) 。

MHSMNetworkRuleSet

一組規則，控管受控 hsm 集區的網路存取範圍。

名稱	類型	Description
bypass	NetworkRuleBypassOptions	告知哪些流量可以略過網路規則。這可以是 'AzureServices' 或 'None'。如果未指定，則預設值為『AzureServices』。
defaultAction	NetworkRuleAction	沒有來自ipRules和 virtualNetworkRules 的規則相符時的預設動作。這只有在評估略過屬性之後才會使用。
ipRules	MHSMIPRule[]	IP 位址規則的清單。
virtualNetworkRules	MHSMVirtualNetworkRule[]	虛擬網路規則的清單。

MHSMPrivateEndpoint

私人端點對象屬性。

名稱	類型	Description
id	string	私人端點資源的完整標識碼。

MHSMPrivateEndpointConnectionItem

私人端點連線專案。

名稱	類型	Description
etag	string	每當私人端點連線的狀態有所變更時，就會進行修改。
id	string	私人端點聯機的標識碼。
properties.privateEndpoint	MHSMPrivateEndpoint	私人端點對象的屬性。
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	私人連結連線的核准狀態。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機的布建狀態。

MHSMPrivateLinkServiceConnectionState

物件，表示私人連結連線的核准狀態。

名稱	類型	Description
actionsRequired	ActionsRequired	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准或拒絕的原因。
status	PrivateEndpointServiceConnectionStatus	指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。

MHSMVirtualNetworkRule

規則，控管來自特定虛擬網路之受控 hsm 集區的存取範圍。

名稱	類型	Description
id	string	vnet 子網的完整資源標識符，例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。

NetworkRuleAction

沒有來自ipRules和 virtualNetworkRules 的規則相符時的預設動作。這只有在評估略過屬性之後才會使用。

名稱	類型	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

告知哪些流量可以略過網路規則。這可以是 'AzureServices' 或 'None'。如果未指定，則預設值為『AzureServices』。

名稱	類型	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

私人端點聯機的布建狀態。

名稱	類型	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

布建狀態。

名稱	類型	Description
Activated	string	受控 HSM 集區已準備好正常使用。
Deleting	string	受控 HSM 集區目前正在刪除。
Failed	string	受控 HSM 集區的布建失敗。
Provisioning	string	目前已布建受控 HSM 集區。
Restoring	string	受控 HSM 集區正從完整 HSM 備份還原。
SecurityDomainRestore	string	受控 HSM 集區正在等候安全性網域還原動作。
Succeeded	string	受控 HSM 集區已完整布建。
Updating	string	受控 HSM 集區目前正在更新。

PublicNetworkAccess

從公用網路控制受控 HSM 的許可權。

名稱	類型	Description
Disabled	string
Enabled	string

SystemData

關於建立和上次修改金鑰保存庫資源的元數據。

名稱	類型	Description
createdAt	string	金鑰保存庫資源建立的時間戳 (UTC) 。
createdBy	string	建立金鑰保存庫資源的身分識別。
createdByType	identityType	建立金鑰保存庫資源的身分識別類型。
lastModifiedAt	string	金鑰保存庫資源上次修改的時間戳 (UTC) 。
lastModifiedBy	string	上次修改金鑰保存庫資源的身分識別。
lastModifiedByType	identityType	上次修改金鑰保存庫資源的身分識別類型。

Managed Hsms - Update

URI 參數

要求本文

回應

安全性

azure_auth

Scopes

範例

Update an existing managed HSM Pool

Sample Request

Sample Response

定義

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

其他資源