Private Endpoint Connection - Update

Service:

Batch Management

API Version:

2024-02-01

Aggiornamenti le proprietà di una connessione endpoint privata esistente.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-02-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account Batch. Regex pattern: ^[a-zA-Z0-9]+$
privateEndpointConnectionName	path	True	string	Nome di connessione dell'endpoint privato. Questo deve essere univoco all'interno dell'account. Regex pattern: ^[a-zA-Z0-9_-]+\.?[a-fA-F0-9-]*$
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente l'account Batch.
subscriptionId	path	True	string	ID sottoscrizione di Azure. Si tratta di una stringa con formato GUID (ad esempio 00000000000-0000-0000-0000-000000000000000)
api-version	query	True	string	Versione dell'API da usare con la richiesta HTTP.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	Versione di stato (ETag) della connessione dell'endpoint privato da aggiornare. Questo valore può essere omesso o impostato su "*" per applicare l'operazione in modo incondizionato.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato. Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateEndpointConnection	L'operazione è stata completata. La risposta contiene PrivateEndpointConnection.
202 Accepted		L'operazione è stata accettata e verrà eseguita in background. Headers Location: string Retry-After: integer
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Microsoft Entra flusso di codice di autenticazione OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

UpdatePrivateEndpointConnection

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0?api-version=2024-02-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by xyz.abc@company.com"
    }
  }
}

Java

import com.azure.resourcemanager.batch.fluent.models.PrivateEndpointConnectionInner;
import com.azure.resourcemanager.batch.models.PrivateLinkServiceConnectionState;
import com.azure.resourcemanager.batch.models.PrivateLinkServiceConnectionStatus;

/**
 * Samples for PrivateEndpointConnection Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateEndpointConnectionUpdate.
     * json
     */
    /**
     * Sample code: UpdatePrivateEndpointConnection.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void updatePrivateEndpointConnection(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.privateEndpointConnections().update("default-azurebatch-japaneast", "sampleacct",
            "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
            new PrivateEndpointConnectionInner().withPrivateLinkServiceConnectionState(
                new PrivateLinkServiceConnectionState().withStatus(PrivateLinkServiceConnectionStatus.APPROVED)
                    .withDescription("Approved by xyz.abc@company.com")),
            null, 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.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python private_endpoint_connection_update.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 = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.private_endpoint_connection.begin_update(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        private_endpoint_connection_name="testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        parameters={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "Approved by xyz.abc@company.com",
                    "status": "Approved",
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateEndpointConnectionUpdate.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 armbatch_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/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateEndpointConnectionUpdate.json
func ExamplePrivateEndpointConnectionClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPrivateEndpointConnectionClient().BeginUpdate(ctx, "default-azurebatch-japaneast", "sampleacct", "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", armbatch.PrivateEndpointConnection{
		Properties: &armbatch.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armbatch.PrivateLinkServiceConnectionState{
				Description: to.Ptr("Approved by xyz.abc@company.com"),
				Status:      to.Ptr(armbatch.PrivateLinkServiceConnectionStatusApproved),
			},
		},
	}, &armbatch.PrivateEndpointConnectionClientBeginUpdateOptions{IfMatch: 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 = armbatch.PrivateEndpointConnection{
	// 	Name: to.Ptr("testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts/privateEndpointConnections"),
	// 	Etag: to.Ptr("W/\"0x8D4EDFEBFADF4AB\""),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 	Properties: &armbatch.PrivateEndpointConnectionProperties{
	// 		GroupIDs: []*string{
	// 			to.Ptr("batchAccount")},
	// 			PrivateEndpoint: &armbatch.PrivateEndpoint{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"),
	// 			},
	// 			PrivateLinkServiceConnectionState: &armbatch.PrivateLinkServiceConnectionState{
	// 				Description: to.Ptr("Approved by xyz.abc@company.com"),
	// 				Status: to.Ptr(armbatch.PrivateLinkServiceConnectionStatusApproved),
	// 			},
	// 			ProvisioningState: to.Ptr(armbatch.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 { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the properties of an existing private endpoint connection.
 *
 * @summary Updates the properties of an existing private endpoint connection.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateEndpointConnectionUpdate.json
 */
async function updatePrivateEndpointConnection() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const privateEndpointConnectionName =
    "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0";
  const parameters = {
    privateLinkServiceConnectionState: {
      description: "Approved by xyz.abc@company.com",
      status: "Approved",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.privateEndpointConnectionOperations.beginUpdateAndWait(
    resourceGroupName,
    accountName,
    privateEndpointConnectionName,
    parameters,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateEndpointConnectionUpdate.json
// this example is just showing the usage of "PrivateEndpointConnection_Update" 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 BatchPrivateEndpointConnectionResource created on azure
// for more information of creating BatchPrivateEndpointConnectionResource, please refer to the document of BatchPrivateEndpointConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string privateEndpointConnectionName = "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0";
ResourceIdentifier batchPrivateEndpointConnectionResourceId = BatchPrivateEndpointConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName);
BatchPrivateEndpointConnectionResource batchPrivateEndpointConnection = client.GetBatchPrivateEndpointConnectionResource(batchPrivateEndpointConnectionResourceId);

// invoke the operation
BatchPrivateEndpointConnectionData data = new BatchPrivateEndpointConnectionData()
{
    ConnectionState = new BatchPrivateLinkServiceConnectionState(BatchPrivateLinkServiceConnectionStatus.Approved)
    {
        Description = "Approved by xyz.abc@company.com",
    },
};
ArmOperation<BatchPrivateEndpointConnectionResource> lro = await batchPrivateEndpointConnection.UpdateAsync(WaitUntil.Completed, data);
BatchPrivateEndpointConnectionResource 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
BatchPrivateEndpointConnectionData 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

Sample Response

Status code:

200

ETag: W/"0x8D4EDFEBFADF4AB"

Response Body

{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
  "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
  "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
    },
    "groupIds": [
      "batchAccount"
    ],
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by xyz.abc@company.com"
    }
  }
}

Status code:

202

Retry-After: 15
Location: https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2024-02-01

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio Batch.
CloudErrorBody	Risposta di errore dal servizio Batch.
PrivateEndpoint	Endpoint privato della connessione dell'endpoint privato.
PrivateEndpointConnection	Contiene informazioni su una risorsa di collegamento privato.
PrivateEndpointConnectionProvisioningState	Stato di provisioning della connessione dell'endpoint privato.
PrivateLinkServiceConnectionState	Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato
PrivateLinkServiceConnectionStatus	Stato della connessione dell'endpoint privato Batch

CloudError

Risposta di errore dal servizio Batch.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo della risposta all'errore.

CloudErrorBody

Risposta di errore dal servizio Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in caso di errore.

PrivateEndpoint

Endpoint privato della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
id	string	Identificatore di risorsa ARM dell'endpoint privato. Si tratta del modulo /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Contiene informazioni su una risorsa di collegamento privato.

Nome	Tipo	Descrizione
etag	string	ETag della risorsa usata per le istruzioni di concorrenza.
id	string	ID della risorsa.
name	string	Nome della risorsa.
properties.groupIds	string[]	ID gruppo della connessione dell'endpoint privato. Il valore ha uno e un solo ID gruppo.
properties.privateEndpoint	PrivateEndpoint	Identificatore di risorsa ARM dell'endpoint privato. Endpoint privato della connessione dell'endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato. Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stato di provisioning della connessione dell'endpoint privato.
type	string	Tipo di risorsa.

PrivateEndpointConnectionProvisioningState

Stato di provisioning della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
Cancelled	string	L'utente ha annullato la creazione della connessione.
Creating	string	La connessione sta creando.
Deleting	string	La connessione viene eliminata.
Failed	string	L'utente ha richiesto che la connessione venga aggiornata e non è riuscita. È possibile ripetere l'operazione di aggiornamento.
Succeeded	string	Lo stato della connessione è finale ed è pronto per l'uso se Lo stato è approvato.
Updating	string	L'utente ha richiesto che lo stato della connessione venga aggiornato, ma l'operazione di aggiornamento non è ancora stata completata. Non è possibile fare riferimento alla connessione quando si connette l'account Batch.

PrivateLinkServiceConnectionState

Stato di connessione del servizio collegamento privato della connessione dell'endpoint privato

Nome	Tipo	Descrizione
actionsRequired	string	Azione necessaria per lo stato di connessione privata
description	string	Descrizione dello stato della connessione privata
status	PrivateLinkServiceConnectionStatus	Stato della connessione dell'endpoint privato dell'account Batch

PrivateLinkServiceConnectionStatus

Stato della connessione dell'endpoint privato Batch

Nome	Tipo	Descrizione
Approved	string	La connessione dell'endpoint privato è approvata e può essere usata per accedere all'account Batch
Disconnected	string	La connessione dell'endpoint privato viene disconnessa e non può essere usata per accedere all'account Batch
Pending	string	La connessione dell'endpoint privato è in sospeso e non può essere usata per accedere all'account Batch
Rejected	string	La connessione dell'endpoint privato viene rifiutata e non può essere usata per accedere all'account Batch