Private Endpoint Connections - Update

參考

Service:: Search Management

API Version:: 2023-11-01

匯報指定資源群組中搜尋服務的私人端點連線。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-11-01

URI 參數

名稱	位於	必要	類型	Description
privateEndpointConnectionName	path	True	string	具有指定資源群組之搜尋服務的私人端點連線名稱。
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
searchServiceName	path	True	string	與指定資源群組相關聯的搜尋服務名稱。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。您可以從 Azure Resource Manager API、命令行工具或入口網站取得此值。
api-version	query	True	string	要用於每個要求的 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	用戶端產生之可識別此要求的 GUID 值。如果指定，回應資訊中將會包含此專案，以追蹤要求的方式。

要求本文

名稱	類型	Description
properties	PrivateEndpointConnectionProperties	描述與搜尋服務之現有私人端點連線的屬性。

回應

名稱	類型	Description
200 OK	PrivateEndpointConnection	已成功更新現有的私人端點連線定義。
Other Status Codes	CloudError	HTTP 400 (不正確的要求) ：指定的私人端點連線名稱或私人端點連線定義無效;如需詳細資訊，請參閱回應中的錯誤碼和訊息。找不到 HTTP 404 () ：找不到訂用帳戶、資源群組、搜尋服務或私人端點連線。 HTTP 409 (衝突) ：指定的訂用帳戶已停用。

安全性

azure_auth

Microsoft Entra ID OAuth2 授權流程。

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

PrivateEndpointConnectionUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2023-11-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason"
    }
  }
}


import com.azure.resourcemanager.search.fluent.models.PrivateEndpointConnectionInner;
import com.azure.resourcemanager.search.models.PrivateEndpointConnectionProperties;
import com.azure.resourcemanager.search.models.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
import com.azure.resourcemanager.search.models.PrivateLinkServiceConnectionStatus;

/** Samples for PrivateEndpointConnections Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection
     * .json
     */
    /**
     * Sample code: PrivateEndpointConnectionUpdate.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void privateEndpointConnectionUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getPrivateEndpointConnections().updateWithResponse("rg1",
            "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
            new PrivateEndpointConnectionInner()
                .withProperties(new PrivateEndpointConnectionProperties().withPrivateLinkServiceConnectionState(
                    new PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState()
                        .withStatus(PrivateLinkServiceConnectionStatus.REJECTED)
                        .withDescription("Rejected for some reason"))),
            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

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

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

    response = client.private_endpoint_connections.update(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        private_endpoint_connection_name="testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
        private_endpoint_connection={
            "properties": {
                "privateLinkServiceConnectionState": {"description": "Rejected for some reason", "status": "Rejected"}
            }
        },
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection.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 armsearch_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/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateEndpointConnectionsClient().Update(ctx, "rg1", "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", armsearch.PrivateEndpointConnection{
		Properties: &armsearch.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
				Description: to.Ptr("Rejected for some reason"),
				Status:      to.Ptr(armsearch.PrivateLinkServiceConnectionStatusRejected),
			},
		},
	}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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 = armsearch.PrivateEndpointConnection{
	// 	Name: to.Ptr("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
	// 	Properties: &armsearch.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("Rejected for some reason"),
	// 			ActionsRequired: to.Ptr("None"),
	// 			Status: to.Ptr(armsearch.PrivateLinkServiceConnectionStatusRejected),
	// 		},
	// 	},
	// }
}

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

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates a Private Endpoint connection to the search service in the given resource group.
 *
 * @summary Updates a Private Endpoint connection to the search service in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection.json
 */
async function privateEndpointConnectionUpdate() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const privateEndpointConnectionName = "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546";
  const privateEndpointConnection = {
    properties: {
      privateLinkServiceConnectionState: {
        description: "Rejected for some reason",
        status: "Rejected",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.privateEndpointConnections.update(
    resourceGroupName,
    searchServiceName,
    privateEndpointConnectionName,
    privateEndpointConnection
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/UpdatePrivateEndpointConnection.json
// this example is just showing the usage of "PrivateEndpointConnections_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 SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// get the collection of this SearchPrivateEndpointConnectionResource
SearchPrivateEndpointConnectionCollection collection = searchService.GetSearchPrivateEndpointConnections();

// invoke the operation
string privateEndpointConnectionName = "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546";
SearchPrivateEndpointConnectionData data = new SearchPrivateEndpointConnectionData()
{
    Properties = new SearchServicePrivateEndpointConnectionProperties()
    {
        ConnectionState = new SearchServicePrivateLinkServiceConnectionState()
        {
            Status = SearchServicePrivateLinkServiceConnectionStatus.Rejected,
            Description = "Rejected for some reason",
        },
    },
};
ArmOperation<SearchPrivateEndpointConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, privateEndpointConnectionName, data);
SearchPrivateEndpointConnectionResource 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
SearchPrivateEndpointConnectionData 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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason",
      "actionsRequired": "None"
    }
  }
}

定義

名稱	Description
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
PrivateEndpoint	來自 Microsoft.Network 提供者的私人端點資源。
PrivateEndpointConnection	描述與搜尋服務的現有私人端點連線。
PrivateEndpointConnectionProperties	描述與搜尋服務之現有私人端點連線的屬性。
PrivateLinkServiceConnectionProvisioningState	私人鏈接服務連線的布建狀態。有效值為更新、刪除、失敗、成功或不完整
PrivateLinkServiceConnectionState	描述與 Azure 私人端點之現有 Private Link 服務連線的目前狀態。
PrivateLinkServiceConnectionStatus	私人鏈接服務連線的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

CloudError

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

CloudErrorBody

描述具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	描述錯誤狀況的錯誤碼，比 HTTP 狀態代碼更精確。可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	例如，特定錯誤的目標 (，錯誤) 中的屬性名稱。

PrivateEndpoint

來自 Microsoft.Network 提供者的私人端點資源。

名稱	類型	Description
id	string	來自 Microsoft.Network 提供者的私人端點資源資源資源標識碼。

PrivateEndpointConnection

描述與搜尋服務的現有私人端點連線。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	PrivateEndpointConnectionProperties	描述與搜尋服務之現有私人端點連線的屬性。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProperties

描述與搜尋服務之現有私人端點連線的屬性。

名稱	類型	Description
groupId	string	私人鏈接服務連線的來源提供者的群組標識碼。
privateEndpoint	PrivateEndpoint	來自 Microsoft.Network 提供者的私人端點資源。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	描述與 Azure 私人端點之現有 Private Link 服務連線的目前狀態。
provisioningState	PrivateLinkServiceConnectionProvisioningState	私人鏈接服務連線的布建狀態。有效值為更新、刪除、失敗、成功或不完整

PrivateLinkServiceConnectionProvisioningState

私人鏈接服務連線的布建狀態。有效值為更新、刪除、失敗、成功或不完整

名稱	類型	Description
Canceled	string	已取消私人連結服務連線資源的布建要求
Deleting	string	私人鏈接服務連線正在進行刪除。
Failed	string	無法布建或刪除私人連結服務連線。
Incomplete	string	已接受私人連結服務連線資源的布建要求，但尚未開始建立程式。
Succeeded	string	私人鏈接服務連線已完成佈建，並已準備好核准。
Updating	string	私人鏈接服務連線正在與其他資源一起建立，以便其能夠完整運作。

PrivateLinkServiceConnectionState

描述與 Azure 私人端點之現有 Private Link 服務連線的目前狀態。

名稱	類型	預設值	Description
actionsRequired	string	None	任何可能需要的額外動作的描述。
description	string		私人鏈接服務連線狀態的描述。
status	PrivateLinkServiceConnectionStatus		私人鏈接服務連線的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

PrivateLinkServiceConnectionStatus

私人鏈接服務連線的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

名稱	類型	Description
Approved	string	私人端點連線已核准並可供使用。
Disconnected	string	私人端點連線已從服務中移除。
Pending	string	已建立私人端點連線，並擱置核准。
Rejected	string	私人端點連線已被拒絕，而且無法使用。