MHSM Private Endpoint Connections - Put

Служба:

Key Vault

Версия API:

2024-11-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-11-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	Изменяется всякий раз при изменении состояния подключения к частной конечной точке.
identity	ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
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	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

ManagedHsmPutPrivateEndpointConnection

Образец запроса

HTTP

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=2024-11-01

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

Java

import com.azure.resourcemanager.keyvault.fluent.models.MhsmPrivateEndpointConnectionInner;
import com.azure.resourcemanager.keyvault.models.MhsmPrivateLinkServiceConnectionState;
import com.azure.resourcemanager.keyvault.models.PrivateEndpointServiceConnectionStatus;

/**
 * Samples for MhsmPrivateEndpointConnections Put.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/
     * ManagedHsm_putPrivateEndpointConnection.json
     */
    /**
     * Sample code: ManagedHsmPutPrivateEndpointConnection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void managedHsmPutPrivateEndpointConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.vaults().manager().serviceClient().getMhsmPrivateEndpointConnections().putWithResponse("sample-group",
            "sample-mhsm", "sample-pec",
            new MhsmPrivateEndpointConnectionInner().withPrivateLinkServiceConnectionState(
                new MhsmPrivateLinkServiceConnectionState().withStatus(PrivateEndpointServiceConnectionStatus.APPROVED)
                    .withDescription("My name is Joe and I'm approving this.")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

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/2024-11-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

Go

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_putPrivateEndpointConnection.json
func ExampleMHSMPrivateEndpointConnectionsClient_Put() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkeyvault.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMHSMPrivateEndpointConnectionsClient().Put(ctx, "sample-group", "sample-mhsm", "sample-pec", armkeyvault.MHSMPrivateEndpointConnection{
		Properties: &armkeyvault.MHSMPrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armkeyvault.MHSMPrivateLinkServiceConnectionState{
				Description: to.Ptr("My name is Joe and I'm approving this."),
				Status:      to.Ptr(armkeyvault.PrivateEndpointServiceConnectionStatusApproved),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MHSMPrivateEndpointConnection = armkeyvault.MHSMPrivateEndpointConnection{
	// 	Name: to.Ptr("sample-pec"),
	// 	Type: to.Ptr("Microsoft.KeyVault/managedhsms/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec"),
	// 	Properties: &armkeyvault.MHSMPrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armkeyvault.MHSMPrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armkeyvault.MHSMPrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("My name is Joe and I'm approving this."),
	// 			ActionsRequired: to.Ptr(armkeyvault.ActionsRequiredNone),
	// 			Status: to.Ptr(armkeyvault.PrivateEndpointServiceConnectionStatusApproved),
	// 		},
	// 		ProvisioningState: to.Ptr(armkeyvault.PrivateEndpointConnectionProvisioningStateSucceeded),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { KeyVaultManagementClient } = require("@azure/arm-keyvault");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates the specified private endpoint connection associated with the managed hsm pool.
 *
 * @summary Updates the specified private endpoint connection associated with the managed hsm pool.
 * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_putPrivateEndpointConnection.json
 */
async function managedHsmPutPrivateEndpointConnection() {
  const subscriptionId =
    process.env["KEYVAULT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["KEYVAULT_RESOURCE_GROUP"] || "sample-group";
  const name = "sample-mhsm";
  const privateEndpointConnectionName = "sample-pec";
  const properties = {
    privateLinkServiceConnectionState: {
      description: "My name is Joe and I'm approving this.",
      status: "Approved",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new KeyVaultManagementClient(credential, subscriptionId);
  const result = await client.mhsmPrivateEndpointConnections.put(
    resourceGroupName,
    name,
    privateEndpointConnectionName,
    properties,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.KeyVault.Models;
using Azure.ResourceManager.KeyVault;

// Generated from example definition: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_putPrivateEndpointConnection.json
// this example is just showing the usage of "MHSMPrivateEndpointConnections_Put" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedHsmResource created on azure
// for more information of creating ManagedHsmResource, please refer to the document of ManagedHsmResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "sample-group";
string name = "sample-mhsm";
ResourceIdentifier managedHsmResourceId = ManagedHsmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
ManagedHsmResource managedHsm = client.GetManagedHsmResource(managedHsmResourceId);

// get the collection of this ManagedHsmPrivateEndpointConnectionResource
ManagedHsmPrivateEndpointConnectionCollection collection = managedHsm.GetManagedHsmPrivateEndpointConnections();

// invoke the operation
string privateEndpointConnectionName = "sample-pec";
ManagedHsmPrivateEndpointConnectionData data = new ManagedHsmPrivateEndpointConnectionData(default)
{
    PrivateLinkServiceConnectionState = new ManagedHsmPrivateLinkServiceConnectionState
    {
        Status = ManagedHsmPrivateEndpointServiceConnectionStatus.Approved,
        Description = "My name is Joe and I'm approving this.",
    },
};
ArmOperation<ManagedHsmPrivateEndpointConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, privateEndpointConnectionName, data);
ManagedHsmPrivateEndpointConnectionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedHsmPrivateEndpointConnectionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
MHSMPrivateEndpointConnection	Ресурс подключения к частной конечной точке.
MHSMPrivateLinkServiceConnectionState	Объект, представляющий состояние утверждения подключения к приватному каналу.
PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения

ActionsRequired

Перечисление

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

Значение	Описание
None

CloudError

Object

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

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

CloudErrorBody

Object

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

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

identityType

Перечисление

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

Значение	Описание
User
Application
ManagedIdentity
Key

ManagedHsmSku

Object

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

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

ManagedHsmSkuFamily

Перечисление

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

Значение	Описание
B
C

ManagedHsmSkuName

Перечисление

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

Значение	Описание
Standard_B1
Custom_B32
Custom_B6
Custom_C42
Custom_C10

ManagedServiceIdentity

Object

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string (uuid)	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MHSMPrivateEndpoint

Object

Свойства объекта частной конечной точки.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса частной конечной точки.

MHSMPrivateEndpointConnection

Object

Ресурс подключения к частной конечной точке.

Имя	Тип	Описание
etag	string	Изменяется всякий раз при изменении состояния подключения к частной конечной точке.
id	string	Идентификатор ресурса Azure Resource Manager для управляемого пула HSM.
identity	ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
location	string	Поддерживаемая папка Azure, в которой должен быть создан управляемый пул HSM.
name	string	Имя управляемого пула HSM.
properties.privateEndpoint	MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Состояние утверждения подключения приватного канала.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
sku	ManagedHsmSku	Сведения о номере SKU
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.
tags	object	Теги ресурсов
type	string	Тип ресурса управляемого пула HSM.

MHSMPrivateLinkServiceConnectionState

Object

Объект, представляющий состояние утверждения подключения к приватному каналу.

Имя	Тип	Описание
actionsRequired	ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения.
status	PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.

PrivateEndpointConnectionProvisioningState

Перечисление

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

Значение	Описание
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

Перечисление

Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.

Значение	Описание
Pending
Approved
Rejected
Disconnected

SystemData

Object

Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.

Имя	Тип	Описание
createdAt	string (date-time)	Временная метка создания ресурса хранилища ключей (UTC).
createdBy	string	Удостоверение, создавшее ресурс хранилища ключей.
createdByType	identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса хранилища ключей (UTC).
lastModifiedBy	string	Удостоверение, которое последним изменило ресурс хранилища ключей.
lastModifiedByType	identityType	Тип удостоверения, которое последним изменило ресурс хранилища ключей.

UserAssignedIdentity

Object

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.