MHSM Private Endpoint Connections - Put

Başvuru

Service:: Key Vault

API Version:: 2022-07-01

Yönetilen hsm havuzuyla ilişkili belirtilen özel uç nokta bağlantısını Güncelleştirmeler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
name	path	True	string	Yönetilen HSM Havuzunun adı
privateEndpointConnectionName	path	True	string	Yönetilen hsm havuzuyla ilişkili özel uç nokta bağlantısının 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
etag	string	Özel uç nokta bağlantısının durumunda bir değişiklik olduğunda değiştirilir.
location	string	Yönetilen HSM Havuzunun oluşturulması gereken desteklenen Azure konumu.
properties.privateEndpoint	MHSMPrivateEndpoint	Özel uç nokta nesnesinin özellikleri.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumu.
sku	ManagedHsmSku	SKU ayrıntıları
tags	object	Kaynak etiketleri

Yanıtlar

Name	Tür	Description
200 OK	MHSMPrivateEndpointConnection	Özel uç nokta bağlantısının durumu başarıyla güncelleştirildi. Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

MHSMPrivateEndpointConnection

Özel uç nokta bağlantısının durumu başarıyla güncelleştirildi.

Headers

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

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

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ManagedHsmPutPrivateEndpointConnection

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

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "My name is Joe and I'm approving this."
    }
  }
}

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_put_private_endpoint_connection.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.mhsm_private_endpoint_connections.put(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
        properties={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "My name is Joe and I'm approving this.",
                    "status": "Approved",
                }
            }
        },
    )
    print(response)


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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "My name is Joe and I'm approving this.",
      "actionsRequired": "None"
    }
  }
}

Tanımlar

Name	Description
ActionsRequired	Hizmet sağlayıcısında yapılan değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
CloudError	Key Vault kaynak sağlayıcısından hata yanıtı
CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı
identityType	Anahtar kasası kaynağını oluşturan kimliğin türü.
ManagedHsmSku	SKU ayrıntıları
ManagedHsmSkuFamily	Yönetilen HSM Havuzunun SKU Ailesi
ManagedHsmSkuName	Yönetilen HSM Havuzunun SKU'su
MHSMPrivateEndpoint	Özel uç nokta nesne özellikleri.
MHSMPrivateEndpointConnection	Özel uç nokta bağlantı kaynağı.
MHSMPrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumunu temsil eden bir nesne.
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.
SystemData	Anahtar kasası kaynağının oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

ActionsRequired

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

Name	Tür	Description
None	string

CloudError

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
error	CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı

CloudErrorBody

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
code	string	Hata kodu. Bu, program aracılığıyla tüketilebilen bir anımsatıcıdır.
message	string	Kullanıcı dostu hata iletisi. İleti genellikle yerelleştirilir ve hizmet sürümüne göre farklılık gösterebilir.

identityType

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

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

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

Yönetilen HSM Havuzunun SKU Ailesi

Name	Tür	Description
B	string

ManagedHsmSkuName

Yönetilen HSM Havuzunun SKU'su

Name	Tür	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string