Private Endpoint Connection - Update

Service:

Batch Management

API Version:

2024-02-01

Updates properti koneksi titik akhir privat yang ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun Batch. Regex pattern: ^[a-zA-Z0-9]+$
privateEndpointConnectionName	path	True	string	Nama koneksi titik akhir privat. Ini harus unik dalam akun. Regex pattern: ^[a-zA-Z0-9_-]+\.?[a-fA-F0-9-]*$
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi akun Batch.
subscriptionId	path	True	string	Atur ID Langganan Azure. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-000000000000)
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan HTTP.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match		string	Versi status (ETag) dari koneksi titik akhir privat yang akan diperbarui. Nilai ini dapat dihilangkan atau diatur ke "*" untuk menerapkan operasi tanpa syarat.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status koneksi layanan tautan privat dari koneksi titik akhir privat. Status koneksi layanan tautan privat dari koneksi titik akhir privat

Respons

Nama	Jenis	Deskripsi
200 OK	PrivateEndpointConnection	Operasi berhasil. Respons berisi PrivateEndpointConnection.
202 Accepted		Operasi diterima dan akan dilakukan di latar belakang. Headers Location: string Retry-After: integer
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Microsoft Entra alur kode autentikasi OAuth 2.0

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari layanan Batch.
CloudErrorBody	Respons kesalahan dari layanan Batch.
PrivateEndpoint	Titik akhir privat koneksi titik akhir privat.
PrivateEndpointConnection	Berisi informasi tentang sumber daya tautan privat.
PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
PrivateLinkServiceConnectionState	Status koneksi layanan tautan privat dari koneksi titik akhir privat
PrivateLinkServiceConnectionStatus	Status koneksi titik akhir privat Batch

CloudError

Respons kesalahan dari layanan Batch.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Isi respons kesalahan.

CloudErrorBody

Respons kesalahan dari layanan Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

PrivateEndpoint

Titik akhir privat koneksi titik akhir privat.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya ARM dari titik akhir privat. Ini adalah formulir /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Berisi informasi tentang sumber daya tautan privat.

Nama	Jenis	Deskripsi
etag	string	ETag sumber daya, digunakan untuk pernyataan konkurensi.
id	string	ID sumber daya.
name	string	Nama sumber daya.
properties.groupIds	string[]	Id grup koneksi titik akhir privat. Nilai memiliki satu dan hanya satu id grup.
properties.privateEndpoint	PrivateEndpoint	Pengidentifikasi sumber daya ARM dari titik akhir privat. Titik akhir privat koneksi titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status koneksi layanan tautan privat dari koneksi titik akhir privat. Status koneksi layanan tautan privat dari koneksi titik akhir privat
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
type	string	Jenis sumber daya.

PrivateEndpointConnectionProvisioningState

Status penyediaan koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Cancelled	string	Pengguna telah membatalkan pembuatan koneksi.
Creating	string	Koneksi sedang dibuat.
Deleting	string	Koneksi sedang dihapus.
Failed	string	Pengguna meminta agar koneksi diperbarui dan gagal. Anda dapat mencoba kembali operasi pembaruan.
Succeeded	string	Status koneksi sudah final dan siap digunakan jika Status Disetujui.
Updating	string	Pengguna telah meminta agar status koneksi diperbarui, tetapi operasi pembaruan belum selesai. Anda mungkin tidak mereferensikan koneksi saat menyambungkan akun Batch.

PrivateLinkServiceConnectionState

Status koneksi layanan tautan privat dari koneksi titik akhir privat

Nama	Jenis	Deskripsi
actionsRequired	string	Tindakan yang diperlukan pada status koneksi privat
description	string	Deskripsi status Koneksi privat
status	PrivateLinkServiceConnectionStatus	Status untuk koneksi titik akhir privat akun Batch

PrivateLinkServiceConnectionStatus

Status koneksi titik akhir privat Batch

Nama	Jenis	Deskripsi
Approved	string	Koneksi titik akhir privat disetujui dan dapat digunakan untuk mengakses akun Batch
Disconnected	string	Koneksi titik akhir privat terputus dan tidak dapat digunakan untuk mengakses akun Batch
Pending	string	Koneksi titik akhir privat tertunda dan tidak dapat digunakan untuk mengakses akun Batch
Rejected	string	Koneksi titik akhir privat ditolak dan tidak dapat digunakan untuk mengakses akun Batch