Private Endpoint Connections - Create Or Update

Dienst:

Monitor

API-Version:

2019-10-17-preview

Genehmigen oder ablehnen Sie eine Verbindung mit einem privaten Endpunkt mit einem bestimmten Namen.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2019-10-17-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
privateEndpointConnectionName	path	True	string	Der Name der Verbindung mit dem privaten Endpunkt.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
scopeName	path	True	string	Der Name der Azure Monitor PrivateLinkScope-Ressource.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties.privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der Verbindung mit dem privaten Endpunkt.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	Die Verbindung mit einem privaten Endpunkt wurde erfolgreich genehmigt oder abgelehnt.
202 Accepted		Akzeptiert

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Approve or reject a private endpoint connection with a given name.

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name?api-version=2019-10-17-preview

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@contoso.com"
    }
  }
}

Go

package armmonitor_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/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateEndpointConnectionUpdate.json
func ExamplePrivateEndpointConnectionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"MyResourceGroup",
		"MyPrivateLinkScope",
		"private-endpoint-connection-name",
		armmonitor.PrivateEndpointConnection{
			Properties: &armmonitor.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armmonitor.PrivateLinkServiceConnectionStateProperty{
					Description: to.Ptr("Approved by johndoe@contoso.com"),
					Status:      to.Ptr("Approved"),
				},
			},
		},
		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)
	}
	// TODO: use response item
	_ = res
}

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 { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Approve or reject a private endpoint connection with a given name.
 *
 * @summary Approve or reject a private endpoint connection with a given name.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/PrivateEndpointConnectionUpdate.json
 */
async function approveOrRejectAPrivateEndpointConnectionWithAGivenName() {
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = "MyResourceGroup";
  const scopeName = "MyPrivateLinkScope";
  const privateEndpointConnectionName = "private-endpoint-connection-name";
  const parameters = {
    privateLinkServiceConnectionState: {
      description: "Approved by johndoe@contoso.com",
      status: "Approved",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.privateEndpointConnections.beginCreateOrUpdateAndWait(
    resourceGroupName,
    scopeName,
    privateEndpointConnectionName,
    parameters
  );
  console.log(result);
}

approveOrRejectAPrivateEndpointConnectionWithAGivenName().catch(console.error);

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:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name",
  "name": "private-endpoint-connection-name",
  "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@contoso.com",
      "actionsRequired": "None"
    }
  }
}

Statuscode:

202

Definitionen

Name	Beschreibung
PrivateEndpointConnection	Eine verbindung mit einem privaten Endpunkt
PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
PrivateLinkServiceConnectionStateProperty	Status der Verbindung mit dem privaten Endpunkt.

PrivateEndpointConnection

Eine verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID
name	string	Name der Azure-Ressource
properties.privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der Verbindung mit dem privaten Endpunkt.
properties.provisioningState	string	Status der Verbindung mit dem privaten Endpunkt.
type	string	Azure-Ressourcentyp

PrivateEndpointProperty

Privater Endpunkt, zu dem die Verbindung gehört.

Name	Typ	Beschreibung
id	string	Ressourcen-ID des privaten Endpunkts.

PrivateLinkServiceConnectionStateProperty

Status der Verbindung mit dem privaten Endpunkt.

Name	Typ	Beschreibung
actionsRequired	string	Die für die Private Link-Dienstverbindung erforderlichen Aktionen.
description	string	Die Verbindungsbeschreibung des Private Link-Diensts.
status	string	Die Private Link-Dienstverbindung status.