Private Link Hubs - Create Or Update

Referenz

Service:: Synapse

API Version:: 2021-06-01

Erstellt oder aktualisiert einen privateLinkHub

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
privateLinkHubName	path	True	string	Name des privateLinkHub
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der geografische Standort, an dem sich die Ressource befindet
properties.provisioningState		string	PrivateLinkHub-Bereitstellungsstatus
tags		object	Ressourcentags.

Antworten

Name

Typ

Beschreibung

200 OK

PrivateLinkHub-Ressourcendetails

201 Created

PrivateLinkHub-Ressourcendetails

Other Status Codes

Fehlerantworten: ***

400 BadRequest: Ungültige Anforderung zum Erstellen eines PrivateLinkHub.
500 InternalServerError: Beim Erstellen von PrivateLinkHub ist ein Fehler aufgetreten.

Beispiele

Create or update a privateLinkHub

Sample Request

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

{
  "properties": {},
  "location": "East US",
  "tags": {
    "key": "value"
  }
}

import java.util.HashMap;
import java.util.Map;

/** Samples for PrivateLinkHubs CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdatePrivateLinkHub.json
     */
    /**
     * Sample code: Create or update a privateLinkHub.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void createOrUpdateAPrivateLinkHub(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .privateLinkHubs()
            .define("privateLinkHub1")
            .withRegion("East US")
            .withExistingResourceGroup("resourceGroup1")
            .withTags(mapOf("key", "value"))
            .create();
    }

    @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

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python create_or_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.create_or_update(
        resource_group_name="resourceGroup1",
        private_link_hub_name="privateLinkHub1",
        private_link_hub_info={"location": "East US", "properties": {}, "tags": {"key": "value"}},
    )
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdatePrivateLinkHub.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 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/CreateOrUpdatePrivateLinkHub.json
func ExamplePrivateLinkHubsClient_CreateOrUpdate() {
	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().CreateOrUpdate(ctx, "resourceGroup1", "privateLinkHub1", armsynapse.PrivateLinkHub{
		Location: to.Ptr("East US"),
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
		Properties: &armsynapse.PrivateLinkHubProperties{},
	}, 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

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

/**
 * This sample demonstrates how to Creates or updates a privateLinkHub
 *
 * @summary Creates or updates a privateLinkHub
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdatePrivateLinkHub.json
 */
async function createOrUpdateAPrivateLinkHub() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "resourceGroup1";
  const privateLinkHubName = "privateLinkHub1";
  const privateLinkHubInfo = {
    location: "East US",
    tags: { key: "value" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.privateLinkHubs.createOrUpdate(
    resourceGroupName,
    privateLinkHubName,
    privateLinkHubInfo
  );
  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.Resources;
using Azure.ResourceManager.Synapse;

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

// get the collection of this SynapsePrivateLinkHubResource
SynapsePrivateLinkHubCollection collection = resourceGroupResource.GetSynapsePrivateLinkHubs();

// invoke the operation
string privateLinkHubName = "privateLinkHub1";
SynapsePrivateLinkHubData data = new SynapsePrivateLinkHubData(new AzureLocation("East US"))
{
    Tags =
    {
    ["key"] = "value",
    },
};
ArmOperation<SynapsePrivateLinkHubResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, privateLinkHubName, data);
SynapsePrivateLinkHubResource 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
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

Sample Response

Status code:: 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"
  }
}

Status code:: 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"
  }
}

Status code:: default

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
PrivateEndpoint	Details zu privaten Endpunkten
PrivateEndpointConnectionForPrivateLinkHubBasic	Private Endpunktverbindung für Private Link Hub – Basic
PrivateLinkHub	Ein privateLinkHub
PrivateLinkServiceConnectionState	Verbindungsstatusdetails des privaten Endpunkts

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PrivateEndpoint

Details zu privaten Endpunkten

Name	Typ	Beschreibung
id	string	Ressourcen-ID des privaten Endpunkts.

PrivateEndpointConnectionForPrivateLinkHubBasic

Private Endpunktverbindung für Private Link Hub – Basic

Name	Typ	Beschreibung
id	string	Bezeichner
properties.privateEndpoint	PrivateEndpoint	Der private Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Verbindungsstatus der privaten Endpunktverbindung.
properties.provisioningState	string	Bereitstellungsstatus der privaten Endpunktverbindung.

PrivateLinkHub

Ein privateLinkHub

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.privateEndpointConnections	PrivateEndpointConnectionForPrivateLinkHubBasic[]	Liste der Verbindungen mit privaten Endpunkten
properties.provisioningState	string	PrivateLinkHub-Bereitstellungsstatus
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Verbindungsstatusdetails des privaten Endpunkts

Name	Typ	Beschreibung
actionsRequired	string	Die aktionen, die für die Private Link-Dienstverbindung erforderlich sind.
description	string	Die Verbindungsbeschreibung des Private Link-Diensts.
status	string	Die Private Link-Dienstverbindung status.