MHSM Private Endpoint Connections - Put

Ссылка

Служба:: Key Vault

Версия API:: 2022-07-01

Обновления указанное подключение к частной конечной точке, связанное с управляемым пулом HSM.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя управляемого пула HSM
privateEndpointConnectionName	path	True	string	Имя подключения к частной конечной точке, связанного с управляемым пулом HSM.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей управляемый пул HSM.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
etag	string	Изменение при изменении состояния подключения к частной конечной точке.
location	string	Поддерживаемая служба Azure, в которой должен быть создан управляемый пул HSM.
properties.privateEndpoint	MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Состояние утверждения подключения к приватному каналу.
sku	ManagedHsmSku	Сведения о номере SKU
tags	object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	MHSMPrivateEndpointConnection	Состояние подключения к частной конечной точке успешно обновлено. Заголовки Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

MHSMPrivateEndpointConnection

Состояние подключения к частной конечной точке успешно обновлено.

Заголовки

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Пример ответа

Код состояния:: 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"
    }
  }
}

Определения

Имя	Описание
ActionsRequired	Сообщение, указывающее, требуют ли изменения в поставщике услуг каких-либо обновлений для потребителя.
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
ManagedHsmSku	Сведения о номере SKU
ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
ManagedHsmSkuName	SKU управляемого пула HSM
MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
MHSMPrivateEndpointConnection	Ресурс подключения к частной конечной точке.
MHSMPrivateLinkServiceConnectionState	Объект , представляющий состояние утверждения подключения приватного канала.
PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
PrivateEndpointServiceConnectionStatus	Указывает, было ли подключение утверждено, отклонено или удалено владельцем хранилища ключей.
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.

ActionsRequired

Сообщение, указывающее, требуют ли изменения в поставщике услуг каких-либо обновлений для потребителя.

Имя	Тип	Описание
None	string

CloudError

Ответ об ошибке от поставщика ресурсов Key Vault

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault

CloudErrorBody

Ответ об ошибке от поставщика ресурсов Key Vault

Имя	Тип	Описание
code	string	Код ошибки. Это мнемоник, который можно использовать программным способом.
message	string	Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться в зависимости от версии службы.

identityType

Тип удостоверения, создавшего ресурс хранилища ключей.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Сведения о номере SKU

Имя	Тип	Описание
family	ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
name	ManagedHsmSkuName	SKU управляемого пула HSM

ManagedHsmSkuFamily

Семейство SKU управляемого пула HSM

Имя	Тип	Описание
B	string

ManagedHsmSkuName

SKU управляемого пула HSM

Имя	Тип	Описание
Custom_B32	string
Custom_B6	string
Standard_B1	string