你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Virtual Endpoints - Update

服务:: PostgreSQL

API 版本:: 2024-08-01

更新灵活服务器的一对虚拟终结点。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}?api-version=2024-08-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	服务器的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
virtualEndpointName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,62}(?	虚拟终端节点的基本名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
properties.endpointType	VirtualEndpointType	虚拟终端节点的终端节点类型。
properties.members	string[]	其中一个虚拟终结点可以引用的灵活服务器列表。

响应

名称

类型

说明

200 OK

VirtualEndpointResource

好的

202 Accepted

已接受

标头

Location: string

Other Status Codes

描述作失败的原因的错误响应。

安全性

azure_auth

Microsoft Entra OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Update a pair of virtual endpoints for a flexible server.

示例请求

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/virtualendpoints/examplebasename?api-version=2024-08-01

{
  "properties": {
    "endpointType": "ReadWrite",
    "members": [
      "exampleprimaryserver"
    ]
  }
}


import com.azure.resourcemanager.postgresqlflexibleserver.models.VirtualEndpointResource;
import com.azure.resourcemanager.postgresqlflexibleserver.models.VirtualEndpointType;
import java.util.Arrays;

/**
 * Samples for VirtualEndpoints Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/
     * VirtualEndpointUpdate.json
     */
    /**
     * Sample code: Update a virtual endpoint for a server to update the.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void updateAVirtualEndpointForAServerToUpdateThe(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        VirtualEndpointResource resource = manager.virtualEndpoints()
            .getWithResponse("testrg", "pgtestsvc4", "pgVirtualEndpoint1", com.azure.core.util.Context.NONE).getValue();
        resource.update().withEndpointType(VirtualEndpointType.READ_WRITE).withMembers(Arrays.asList("testReplica1"))
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python virtual_endpoint_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 = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.virtual_endpoints.begin_update(
        resource_group_name="testrg",
        server_name="pgtestsvc4",
        virtual_endpoint_name="pgVirtualEndpoint1",
        parameters={"properties": {"endpointType": "ReadWrite", "members": ["testReplica1"]}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.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

package armpostgresqlflexibleservers_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/postgresql/armpostgresqlflexibleservers/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ecee919199a39cc0d864410f540aa105bf7cdb64/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json
func ExampleVirtualEndpointsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualEndpointsClient().BeginUpdate(ctx, "testrg", "pgtestsvc4", "pgVirtualEndpoint1", armpostgresqlflexibleservers.VirtualEndpointResourceForPatch{
		Properties: &armpostgresqlflexibleservers.VirtualEndpointResourceProperties{
			EndpointType: to.Ptr(armpostgresqlflexibleservers.VirtualEndpointTypeReadWrite),
			Members: []*string{
				to.Ptr("testReplica1")},
		},
	}, 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.VirtualEndpointResource = armpostgresqlflexibleservers.VirtualEndpointResource{
	// 	Name: to.Ptr("pgVirtualEndpoint1"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1"),
	// 	Properties: &armpostgresqlflexibleservers.VirtualEndpointResourceProperties{
	// 		EndpointType: to.Ptr(armpostgresqlflexibleservers.VirtualEndpointTypeReadWrite),
	// 		Members: []*string{
	// 			to.Ptr("testReplica1")},
	// 			VirtualEndpoints: []*string{
	// 				to.Ptr("pgVirtualEndpoint1.reader.postgres.database.azure.com"),
	// 				to.Ptr("pgVirtualEndpoint1.writer.postgres.database.azure.com")},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.
 *
 * @summary Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json
 */
async function updateAVirtualEndpointForAServerToUpdateThe() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "testrg";
  const serverName = "pgtestsvc4";
  const virtualEndpointName = "pgVirtualEndpoint1";
  const parameters = {
    endpointType: "ReadWrite",
    members: ["testReplica1"],
  };
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.virtualEndpoints.beginUpdateAndWait(
    resourceGroupName,
    serverName,
    virtualEndpointName,
    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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.PostgreSql.FlexibleServers.Models;
using Azure.ResourceManager.PostgreSql.FlexibleServers;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json
// this example is just showing the usage of "VirtualEndpoints_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 VirtualEndpointResource created on azure
// for more information of creating VirtualEndpointResource, please refer to the document of VirtualEndpointResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "testrg";
string serverName = "pgtestsvc4";
string virtualEndpointName = "pgVirtualEndpoint1";
ResourceIdentifier virtualEndpointResourceId = VirtualEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, virtualEndpointName);
VirtualEndpointResource virtualEndpointResource = client.GetVirtualEndpointResource(virtualEndpointResourceId);

// invoke the operation
VirtualEndpointResourcePatch patch = new VirtualEndpointResourcePatch()
{
    EndpointType = VirtualEndpointType.ReadWrite,
    Members =
    {
    "testReplica1"
    },
};
ArmOperation<VirtualEndpointResource> lro = await virtualEndpointResource.UpdateAsync(WaitUntil.Completed, patch);
VirtualEndpointResource 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
VirtualEndpointResourceData 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

示例响应

状态代码:: 200

{
  "properties": {
    "endpointType": "ReadWrite",
    "members": [
      "exampleprimaryserver"
    ],
    "virtualEndpoints": [
      "examplebasename.reader.postgres.database.azure.com",
      "examplebasename.writer.postgres.database.azure.com"
    ]
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/virtualEndpoints/examplebasename",
  "name": "examplebasename",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
systemData	与创建和上次修改资源相关的元数据。
VirtualEndpointResource	灵活服务器的一对虚拟终结点。
VirtualEndpointResourceForPatch	灵活服务器的一对虚拟终结点。
VirtualEndpointType	虚拟终端节点的终端节点类型。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

VirtualEndpointResource

Object

灵活服务器的一对虚拟终结点。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.endpointType	VirtualEndpointType	虚拟终端节点的终端节点类型。
properties.members	string[]	其中一个虚拟终结点可以引用的灵活服务器列表。
properties.virtualEndpoints	string[]	灵活服务器的虚拟终结点列表。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

VirtualEndpointResourceForPatch

Object

灵活服务器的一对虚拟终结点。

名称	类型	说明
properties.endpointType	VirtualEndpointType	虚拟终端节点的终端节点类型。
properties.members	string[]	其中一个虚拟终结点可以引用的灵活服务器列表。
properties.virtualEndpoints	string[]	灵活服务器的虚拟终结点列表。

VirtualEndpointType

枚举

虚拟终端节点的终端节点类型。

值	说明
ReadWrite