Private Endpoint Connection - Update

Service:

Batch Management

API Version:

2024-02-01

Frissítések meglévő privát végponti kapcsolat tulajdonságait.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	A Batch-fiók neve. Regex pattern: ^[a-zA-Z0-9]+$
privateEndpointConnectionName	path	True	string	A privát végpont kapcsolatának neve. Ennek egyedinek kell lennie a fiókon belül. Regex pattern: ^[a-zA-Z0-9_-]+\.?[a-fA-F0-9-]*$
resourceGroupName	path	True	string	A Batch-fiókot tartalmazó erőforráscsoport neve.
subscriptionId	path	True	string	Az Azure-előfizetés azonosítója. Ez egy GUID formátumú sztring (pl. 00000000-0000-0000-0000-0000000000000)
api-version	query	True	string	A HTTP-kéréshez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
If-Match		string	A frissíteni kívánt privát végpontkapcsolat állapotának (ETag) verziója. Ez az érték kihagyható vagy "*" értékre állítható a művelet feltétel nélküli alkalmazásához.

Kérelem törzse

Name	Típus	Description
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A privát végpont kapcsolati állapota. A privát végpont kapcsolatának privát kapcsolati állapota

Válaszok

Name	Típus	Description
200 OK	PrivateEndpointConnection	A művelet sikeres volt. A válasz tartalmazza a PrivateEndpointConnection parancsot.
202 Accepted		A művelet el lett fogadva, és a háttérben lesz végrehajtva. Headers Location: string Retry-After: integer
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
CloudError	Hibaválasz a Batch szolgáltatástól.
CloudErrorBody	Hibaválasz a Batch szolgáltatástól.
PrivateEndpoint	A privát végponti kapcsolat privát végpontja.
PrivateEndpointConnection	Egy privát kapcsolati erőforrással kapcsolatos információkat tartalmaz.
PrivateEndpointConnectionProvisioningState	A privát végpontkapcsolat kiépítési állapota.
PrivateLinkServiceConnectionState	A privát végpont kapcsolatának privát kapcsolati állapota
PrivateLinkServiceConnectionStatus	A Batch privát végpontkapcsolat állapota

CloudError

Hibaválasz a Batch szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	A hibaválasz törzse.

CloudErrorBody

Hibaválasz a Batch szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a hibás tulajdonság neve.

PrivateEndpoint

A privát végponti kapcsolat privát végpontja.

Name	Típus	Description
id	string	A privát végpont ARM-erőforrás-azonosítója. Ez az űrlap /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Egy privát kapcsolati erőforrással kapcsolatos információkat tartalmaz.

Name	Típus	Description
etag	string	Az erőforrás ETagje, amely az egyidejűségi utasításokhoz használatos.
id	string	Az erőforrás azonosítója.
name	string	Az erőforrás neve.
properties.groupIds	string[]	A privát végpontkapcsolat csoportazonosítója. Az érték egy és csak egy csoportazonosítóval rendelkezik.
properties.privateEndpoint	PrivateEndpoint	A privát végpont ARM-erőforrás-azonosítója. A privát végponti kapcsolat privát végpontja.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A privát végpont kapcsolati állapota. A privát végpont kapcsolatának privát kapcsolati állapota
properties.provisioningState	PrivateEndpointConnectionProvisioningState	A privát végpontkapcsolat kiépítési állapota.
type	string	Az erőforrás típusa.

PrivateEndpointConnectionProvisioningState

A privát végpontkapcsolat kiépítési állapota.

Name	Típus	Description
Cancelled	string	A felhasználó megszakította a kapcsolat létrehozását.
Creating	string	A kapcsolat létre van hozva.
Deleting	string	A kapcsolat törölve van.
Failed	string	A felhasználó kérte a kapcsolat frissítését, és sikertelen volt. Újrapróbálkozhat a frissítési művelettel.
Succeeded	string	A kapcsolat állapota végleges, és használatra kész, ha az Állapot jóváhagyva.
Updating	string	A felhasználó kérte a kapcsolat állapotának frissítését, de a frissítési művelet még nem fejeződött be. Előfordulhat, hogy a Batch-fiók csatlakoztatásakor nem hivatkozik a kapcsolatra.

PrivateLinkServiceConnectionState

A privát végpont kapcsolatának privát kapcsolati állapota

Name	Típus	Description
actionsRequired	string	A privát kapcsolat állapotában szükséges művelet
description	string	A privát kapcsolat állapotának leírása
status	PrivateLinkServiceConnectionStatus	A Batch-fiók privát végpontkapcsolatának állapota

PrivateLinkServiceConnectionStatus

A Batch privát végpontkapcsolat állapota

Name	Típus	Description
Approved	string	A privát végponti kapcsolat jóváhagyott, és a Batch-fiók elérésére használható
Disconnected	string	A privát végpont kapcsolata megszakadt, és nem használható a Batch-fiók elérésére
Pending	string	A privát végpont kapcsolata függőben van, és nem használható a Batch-fiók eléréséhez
Rejected	string	A privát végpont kapcsolata elutasítva, és nem használható a Batch-fiók elérésére