Private Link Hubs - Update

Layanan:

Synapse

Versi API:

2021-06-01

Memperbarui privateLinkHub

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
privateLinkHubName	path	True	string	Nama privateLinkHub
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
tags	object	Tag sumber daya

Respons

Nama	Jenis	Deskripsi
200 OK	PrivateLinkHub	Detail sumber daya PrivateLinkHub
201 Created	PrivateLinkHub	Detail sumber daya PrivateLinkHub
Other Status Codes	ErrorResponse	Respons Kesalahan: *** 400 BadRequest - Permintaan tidak valid untuk membuat PrivateLinkHub. 500 InternalServerError- Beberapa kesalahan terjadi saat membuat PrivateLinkHub.

Contoh

Update a privateLinkHub

Permintaan sampel

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

Respon sampel

Kode status:

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"
  }
}

Kode status:

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"
  }
}

Kode status:

default

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

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
PrivateEndpoint	Detail titik akhir privat
PrivateEndpointConnectionForPrivateLinkHubBasic	Koneksi Titik Akhir Privat untuk Hub Private Link - Dasar
PrivateLinkHub	PrivateLinkHub
PrivateLinkHubPatchInfo	Detail patch PrivateLinkHub
PrivateLinkServiceConnectionState	Detail status koneksi titik akhir privat

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

PrivateEndpoint

Objek

Detail titik akhir privat

Nama	Jenis	Deskripsi
id	string	Id sumber daya titik akhir privat.

PrivateEndpointConnectionForPrivateLinkHubBasic

Objek

Koneksi Titik Akhir Privat untuk Hub Private Link - Dasar

Nama	Jenis	Deskripsi
id	string	pengidentifikasi
properties.privateEndpoint	PrivateEndpoint	Titik akhir privat tempat koneksi berada.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status koneksi koneksi titik akhir privat.
properties.provisioningState	string	Status provisi koneksi titik akhir privat.

PrivateLinkHub

Objek

PrivateLinkHub

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.privateEndpointConnections	PrivateEndpointConnectionForPrivateLinkHubBasic[]	Daftar koneksi titik akhir privat
properties.provisioningState	string	Status provisi PrivateLinkHub
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PrivateLinkHubPatchInfo

Objek

Detail patch PrivateLinkHub

Nama	Jenis	Deskripsi
tags	object	Tag sumber daya

PrivateLinkServiceConnectionState

Objek

Detail status koneksi titik akhir privat

Nama	Jenis	Deskripsi
actionsRequired	string	Tindakan yang diperlukan untuk koneksi layanan tautan privat.
description	string	Deskripsi koneksi layanan tautan privat.
status	string	Status koneksi layanan tautan privat.