Private Link Hubs - Update

서비스:

Synapse

API 버전:

2021-06-01

privateLinkHub를 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}?api-version=2021-06-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
privateLinkHubName	path	True	string	privateLinkHub의 이름
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
tags	object	리소스 태그

응답

Name	형식	Description
200 OK	PrivateLinkHub	PrivateLinkHub 리소스 세부 정보
201 Created	PrivateLinkHub	PrivateLinkHub 리소스 세부 정보
Other Status Codes	ErrorResponse	오류 응답: *** 400 BadRequest - PrivateLinkHub를 만들기 위한 요청이 잘못되었습니다. 500 InternalServerError - PrivateLinkHub를 만드는 동안 일부 오류가 발생했습니다.

예제

Update a privateLinkHub

샘플 요청

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1?api-version=2021-06-01

{
  "tags": {
    "key": "value"
  }
}

Java

import com.azure.resourcemanager.synapse.models.PrivateLinkHub;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for PrivateLinkHubs Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdatePrivateLinkHub.json
     */
    /**
     * Sample code: Update a privateLinkHub.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void updateAPrivateLinkHub(com.azure.resourcemanager.synapse.SynapseManager manager) {
        PrivateLinkHub resource = manager.privateLinkHubs()
            .getByResourceGroupWithResponse("resourceGroup1", "privateLinkHub1", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withTags(mapOf("key", "fakeTokenPlaceholder")).apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python update_private_link_hub.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 = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.private_link_hubs.update(
        resource_group_name="resourceGroup1",
        private_link_hub_name="privateLinkHub1",
        private_link_hub_patch_info={"tags": {"key": "value"}},
    )
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdatePrivateLinkHub.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 armsynapse_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/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdatePrivateLinkHub.json
func ExamplePrivateLinkHubsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkHubsClient().Update(ctx, "resourceGroup1", "privateLinkHub1", armsynapse.PrivateLinkHubPatchInfo{
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
	}, 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.PrivateLinkHub = armsynapse.PrivateLinkHub{
	// 	Name: to.Ptr("privateLinkHub1"),
	// 	Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.PrivateLinkHubProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

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 { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates a privateLinkHub
 *
 * @summary Updates a privateLinkHub
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdatePrivateLinkHub.json
 */
async function updateAPrivateLinkHub() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "resourceGroup1";
  const privateLinkHubName = "privateLinkHub1";
  const privateLinkHubPatchInfo = {
    tags: { key: "value" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.privateLinkHubs.update(
    resourceGroupName,
    privateLinkHubName,
    privateLinkHubPatchInfo
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Synapse.Models;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdatePrivateLinkHub.json
// this example is just showing the usage of "PrivateLinkHubs_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 SynapsePrivateLinkHubResource created on azure
// for more information of creating SynapsePrivateLinkHubResource, please refer to the document of SynapsePrivateLinkHubResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "resourceGroup1";
string privateLinkHubName = "privateLinkHub1";
ResourceIdentifier synapsePrivateLinkHubResourceId = SynapsePrivateLinkHubResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, privateLinkHubName);
SynapsePrivateLinkHubResource synapsePrivateLinkHub = client.GetSynapsePrivateLinkHubResource(synapsePrivateLinkHubResourceId);

// invoke the operation
SynapsePrivateLinkHubPatch patch = new SynapsePrivateLinkHubPatch
{
    Tags =
    {
    ["key"] = "value"
    },
};
SynapsePrivateLinkHubResource result = await synapsePrivateLinkHub.UpdateAsync(patch);

// 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
SynapsePrivateLinkHubData 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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1",
  "name": "privateLinkHub1",
  "type": "Microsoft.Synapse/privateLinkHubs",
  "location": "East US",
  "properties": {
    "provisioningState": "Succeeded"
  },
  "tags": {
    "key": "value"
  }
}

상태 코드:

201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1",
  "name": "privateLinkHub1",
  "type": "Microsoft.Synapse/privateLinkHubs",
  "location": "East US",
  "properties": {
    "provisioningState": "Succeeded"
  },
  "tags": {
    "key": "value"
  }
}

상태 코드:

default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
PrivateEndpoint	프라이빗 엔드포인트 세부 정보
PrivateEndpointConnectionForPrivateLinkHubBasic	Private Link Hub에 대한 프라이빗 엔드포인트 연결 - 기본
PrivateLinkHub	privateLinkHub
PrivateLinkHubPatchInfo	PrivateLinkHub 패치 세부 정보
PrivateLinkServiceConnectionState	프라이빗 엔드포인트의 연결 상태 세부 정보

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

PrivateEndpoint

Object

프라이빗 엔드포인트 세부 정보

Name	형식	Description
id	string	프라이빗 엔드포인트의 리소스 ID입니다.

PrivateEndpointConnectionForPrivateLinkHubBasic

Object

Private Link Hub에 대한 프라이빗 엔드포인트 연결 - 기본

Name	형식	Description
id	string	식별자
properties.privateEndpoint	PrivateEndpoint	연결이 속한 프라이빗 엔드포인트입니다.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	프라이빗 엔드포인트 연결의 연결 상태입니다.
properties.provisioningState	string	프라이빗 엔드포인트 연결의 프로비전 상태입니다.

PrivateLinkHub

Object

privateLinkHub

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties.privateEndpointConnections	PrivateEndpointConnectionForPrivateLinkHubBasic[]	프라이빗 엔드포인트 연결 목록
properties.provisioningState	string	PrivateLinkHub 프로비저닝 상태
tags	object	리소스 태그.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PrivateLinkHubPatchInfo

Object

PrivateLinkHub 패치 세부 정보

Name	형식	Description
tags	object	리소스 태그

PrivateLinkServiceConnectionState

Object

프라이빗 엔드포인트의 연결 상태 세부 정보

Name	형식	Description
actionsRequired	string	프라이빗 링크 서비스 연결에 필요한 작업입니다.
description	string	프라이빗 링크 서비스 연결 설명입니다.
status	string	프라이빗 링크 서비스 연결 상태입니다.