Disk Accesses - Update A Private Endpoint Connection

Dienst:

Compute

API-Version:

2024-03-02

Genehmigen oder Ablehnen einer privaten Endpunktverbindung unter datenträgerzugriffsressource, kann dies nicht zum Erstellen einer neuen privaten Endpunktverbindung verwendet werden.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-03-02

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
diskAccessName	path	True	string	Der Name der zu erstellenden Datenträgerzugriffsressource. Der Name kann nicht geändert werden, nachdem der Datenträgerverschlüsselungssatz erstellt wurde. Unterstützte Zeichen für den Namen sind a-z, A-Z, 0-9, _ und -. Die maximale Namelänge beträgt 80 Zeichen.
privateEndpointConnectionName	path	True	string	Der Name der privaten Endpunktverbindung.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.privateLinkServiceConnectionState	True	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen zum Status der Verbindung zwischen DiskAccess und virtuellem Netzwerk.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	OKAY
202 Accepted	PrivateEndpointConnection	Angenommen
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Approve a Private Endpoint Connection under a disk access resource.

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpointConnections/myPrivateEndpointConnection?api-version=2024-03-02

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approving myPrivateEndpointConnection"
    }
  }
}

Java

import com.azure.resourcemanager.compute.fluent.models.PrivateEndpointConnectionInner;
import com.azure.resourcemanager.compute.models.PrivateEndpointServiceConnectionStatus;
import com.azure.resourcemanager.compute.models.PrivateLinkServiceConnectionState;

/**
 * Samples for DiskAccesses UpdateAPrivateEndpointConnection.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/
     * DiskAccessPrivateEndpointConnection_Approve.json
     */
    /**
     * Sample code: Approve a Private Endpoint Connection under a disk access resource.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void approveAPrivateEndpointConnectionUnderADiskAccessResource(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDiskAccesses().updateAPrivateEndpointConnection(
            "myResourceGroup", "myDiskAccess", "myPrivateEndpointConnection",
            new PrivateEndpointConnectionInner().withPrivateLinkServiceConnectionState(
                new PrivateLinkServiceConnectionState().withStatus(PrivateEndpointServiceConnectionStatus.APPROVED)
                    .withDescription("Approving myPrivateEndpointConnection")),
            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 typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python disk_access_private_endpoint_connection_approve.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 = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.disk_accesses.begin_update_a_private_endpoint_connection(
        resource_group_name="myResourceGroup",
        disk_access_name="myDiskAccess",
        private_endpoint_connection_name="myPrivateEndpointConnection",
        private_endpoint_connection={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "Approving myPrivateEndpointConnection",
                    "status": "Approved",
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.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 armcompute_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/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json
func ExampleDiskAccessesClient_BeginUpdateAPrivateEndpointConnection() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDiskAccessesClient().BeginUpdateAPrivateEndpointConnection(ctx, "myResourceGroup", "myDiskAccess", "myPrivateEndpointConnection", armcompute.PrivateEndpointConnection{
		Properties: &armcompute.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armcompute.PrivateLinkServiceConnectionState{
				Description: to.Ptr("Approving myPrivateEndpointConnection"),
				Status:      to.Ptr(armcompute.PrivateEndpointServiceConnectionStatusApproved),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.PrivateEndpointConnection = armcompute.PrivateEndpointConnection{
	// 	Name: to.Ptr("myPrivateEndpointConnectionName"),
	// 	Type: to.Ptr("Microsoft.Compute/diskAccesses/PrivateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnectionName"),
	// 	Properties: &armcompute.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armcompute.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armcompute.PrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("Approving myPrivateEndpointConnection"),
	// 			ActionsRequired: to.Ptr("None"),
	// 			Status: to.Ptr(armcompute.PrivateEndpointServiceConnectionStatusApproved),
	// 		},
	// 		ProvisioningState: to.Ptr(armcompute.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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.
 *
 * @summary Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json
 */
async function approveAPrivateEndpointConnectionUnderADiskAccessResource() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const diskAccessName = "myDiskAccess";
  const privateEndpointConnectionName = "myPrivateEndpointConnection";
  const privateEndpointConnection = {
    privateLinkServiceConnectionState: {
      description: "Approving myPrivateEndpointConnection",
      status: "Approved",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.diskAccesses.beginUpdateAPrivateEndpointConnectionAndWait(
    resourceGroupName,
    diskAccessName,
    privateEndpointConnectionName,
    privateEndpointConnection,
  );
  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.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json
// this example is just showing the usage of "DiskAccesses_UpdateAPrivateEndpointConnection" 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 ComputePrivateEndpointConnectionResource created on azure
// for more information of creating ComputePrivateEndpointConnectionResource, please refer to the document of ComputePrivateEndpointConnectionResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string diskAccessName = "myDiskAccess";
string privateEndpointConnectionName = "myPrivateEndpointConnection";
ResourceIdentifier computePrivateEndpointConnectionResourceId = ComputePrivateEndpointConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, diskAccessName, privateEndpointConnectionName);
ComputePrivateEndpointConnectionResource computePrivateEndpointConnection = client.GetComputePrivateEndpointConnectionResource(computePrivateEndpointConnectionResourceId);

// invoke the operation
ComputePrivateEndpointConnectionData data = new ComputePrivateEndpointConnectionData
{
    ConnectionState = new ComputePrivateLinkServiceConnectionState
    {
        Status = ComputePrivateEndpointServiceConnectionStatus.Approved,
        Description = "Approving myPrivateEndpointConnection",
    },
};
ArmOperation<ComputePrivateEndpointConnectionResource> lro = await computePrivateEndpointConnection.UpdateAsync(WaitUntil.Completed, data);
ComputePrivateEndpointConnectionResource 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
ComputePrivateEndpointConnectionData 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

Beispiel für eine Antwort

Statuscode:

202

{
  "name": "myPrivateEndpointConenction",
  "type": "Microsoft.Compute/diskAccesses/privateEndpointConnections",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnectionName",
  "properties": {
    "provisioningState": "Updating",
    "privateEndpoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "None",
      "description": "Approving myPrivateEndpointConnection",
      "status": "Approved"
    }
  }
}

Statuscode:

200

{
  "name": "myPrivateEndpointConnectionName",
  "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnectionName",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "None",
      "description": "Approving myPrivateEndpointConnection",
      "status": "Approved"
    }
  }
}

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort des Computediensts.
InnerError	Innere Fehlerdetails.
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die Private Endpoint Connection-Ressource.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die API-Fehlerdetails
innererror	InnerError	Interner API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

CloudError

Objekt

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

PrivateEndpoint

Objekt

Die Private Endpoint-Ressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte

PrivateEndpointConnection

Objekt

Die Private Endpoint Connection-Ressource.

Name	Typ	Beschreibung
id	string	Private Endpunkt-Verbindungs-ID
name	string	Name der privaten Endpunktverbindung
properties.privateEndpoint	PrivateEndpoint	Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen zum Status der Verbindung zwischen DiskAccess und virtuellem Netzwerk.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.
type	string	Verbindungstyp für private Endpunkte

PrivateEndpointConnectionProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

Der Status der privaten Endpunktverbindung.

Wert	Beschreibung
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.