1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. PrivateLinkHub
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.synapse.PrivateLinkHub

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    A privateLinkHub Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-03-01.

    Other available API versions: 2021-06-01-preview.

    Example Usage

    Create or update a privateLinkHub

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var privateLinkHub = new AzureNative.Synapse.PrivateLinkHub("privateLinkHub", new()
        {
            Location = "East US",
            PrivateLinkHubName = "privateLinkHub1",
            ResourceGroupName = "resourceGroup1",
            Tags = 
            {
                { "key", "value" },
            },
        });
    
    });
    
    package main
    
    import (
    	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := synapse.NewPrivateLinkHub(ctx, "privateLinkHub", &synapse.PrivateLinkHubArgs{
    			Location:           pulumi.String("East US"),
    			PrivateLinkHubName: pulumi.String("privateLinkHub1"),
    			ResourceGroupName:  pulumi.String("resourceGroup1"),
    			Tags: pulumi.StringMap{
    				"key": pulumi.String("value"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.synapse.PrivateLinkHub;
    import com.pulumi.azurenative.synapse.PrivateLinkHubArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var privateLinkHub = new PrivateLinkHub("privateLinkHub", PrivateLinkHubArgs.builder()
                .location("East US")
                .privateLinkHubName("privateLinkHub1")
                .resourceGroupName("resourceGroup1")
                .tags(Map.of("key", "value"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    private_link_hub = azure_native.synapse.PrivateLinkHub("privateLinkHub",
        location="East US",
        private_link_hub_name="privateLinkHub1",
        resource_group_name="resourceGroup1",
        tags={
            "key": "value",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const privateLinkHub = new azure_native.synapse.PrivateLinkHub("privateLinkHub", {
        location: "East US",
        privateLinkHubName: "privateLinkHub1",
        resourceGroupName: "resourceGroup1",
        tags: {
            key: "value",
        },
    });
    
    resources:
      privateLinkHub:
        type: azure-native:synapse:PrivateLinkHub
        properties:
          location: East US
          privateLinkHubName: privateLinkHub1
          resourceGroupName: resourceGroup1
          tags:
            key: value
    

    Create PrivateLinkHub Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateLinkHub(name: string, args: PrivateLinkHubArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateLinkHub(resource_name: str,
                       args: PrivateLinkHubArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivateLinkHub(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       resource_group_name: Optional[str] = None,
                       location: Optional[str] = None,
                       private_link_hub_name: Optional[str] = None,
                       provisioning_state: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewPrivateLinkHub(ctx *Context, name string, args PrivateLinkHubArgs, opts ...ResourceOption) (*PrivateLinkHub, error)
    public PrivateLinkHub(string name, PrivateLinkHubArgs args, CustomResourceOptions? opts = null)
    public PrivateLinkHub(String name, PrivateLinkHubArgs args)
    public PrivateLinkHub(String name, PrivateLinkHubArgs args, CustomResourceOptions options)
    
    type: azure-native:synapse:PrivateLinkHub
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PrivateLinkHubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateLinkHubArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateLinkHubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateLinkHubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateLinkHubArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var privateLinkHubResource = new AzureNative.Synapse.PrivateLinkHub("privateLinkHubResource", new()
    {
        ResourceGroupName = "string",
        Location = "string",
        PrivateLinkHubName = "string",
        ProvisioningState = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := synapse.NewPrivateLinkHub(ctx, "privateLinkHubResource", &synapse.PrivateLinkHubArgs{
    	ResourceGroupName:  pulumi.String("string"),
    	Location:           pulumi.String("string"),
    	PrivateLinkHubName: pulumi.String("string"),
    	ProvisioningState:  pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var privateLinkHubResource = new PrivateLinkHub("privateLinkHubResource", PrivateLinkHubArgs.builder()
        .resourceGroupName("string")
        .location("string")
        .privateLinkHubName("string")
        .provisioningState("string")
        .tags(Map.of("string", "string"))
        .build());
    
    private_link_hub_resource = azure_native.synapse.PrivateLinkHub("privateLinkHubResource",
        resource_group_name="string",
        location="string",
        private_link_hub_name="string",
        provisioning_state="string",
        tags={
            "string": "string",
        })
    
    const privateLinkHubResource = new azure_native.synapse.PrivateLinkHub("privateLinkHubResource", {
        resourceGroupName: "string",
        location: "string",
        privateLinkHubName: "string",
        provisioningState: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:synapse:PrivateLinkHub
    properties:
        location: string
        privateLinkHubName: string
        provisioningState: string
        resourceGroupName: string
        tags:
            string: string
    

    PrivateLinkHub Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrivateLinkHub resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Location string
    The geo-location where the resource lives
    PrivateLinkHubName string
    Name of the privateLinkHub
    ProvisioningState string
    PrivateLinkHub provisioning state
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Location string
    The geo-location where the resource lives
    PrivateLinkHubName string
    Name of the privateLinkHub
    ProvisioningState string
    PrivateLinkHub provisioning state
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    location String
    The geo-location where the resource lives
    privateLinkHubName String
    Name of the privateLinkHub
    provisioningState String
    PrivateLinkHub provisioning state
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    location string
    The geo-location where the resource lives
    privateLinkHubName string
    Name of the privateLinkHub
    provisioningState string
    PrivateLinkHub provisioning state
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    location str
    The geo-location where the resource lives
    private_link_hub_name str
    Name of the privateLinkHub
    provisioning_state str
    PrivateLinkHub provisioning state
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    location String
    The geo-location where the resource lives
    privateLinkHubName String
    Name of the privateLinkHub
    provisioningState String
    PrivateLinkHub provisioning state
    tags Map<String>
    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateLinkHub resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    PrivateEndpointConnections List<Pulumi.AzureNative.Synapse.Outputs.PrivateEndpointConnectionForPrivateLinkHubBasicResponse>
    List of private endpoint connections
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    PrivateEndpointConnections []PrivateEndpointConnectionForPrivateLinkHubBasicResponse
    List of private endpoint connections
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    privateEndpointConnections List<PrivateEndpointConnectionForPrivateLinkHubBasicResponse>
    List of private endpoint connections
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    privateEndpointConnections PrivateEndpointConnectionForPrivateLinkHubBasicResponse[]
    List of private endpoint connections
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    private_endpoint_connections Sequence[PrivateEndpointConnectionForPrivateLinkHubBasicResponse]
    List of private endpoint connections
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    privateEndpointConnections List<Property Map>
    List of private endpoint connections
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    PrivateEndpointConnectionForPrivateLinkHubBasicResponse, PrivateEndpointConnectionForPrivateLinkHubBasicResponseArgs

    Id string
    identifier
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    PrivateEndpoint Pulumi.AzureNative.Synapse.Inputs.PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Synapse.Inputs.PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection.
    Id string
    identifier
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    PrivateEndpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection.
    id String
    identifier
    provisioningState String
    Provisioning state of the private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection.
    id string
    identifier
    provisioningState string
    Provisioning state of the private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection.
    id str
    identifier
    provisioning_state str
    Provisioning state of the private endpoint connection.
    private_endpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection.
    id String
    identifier
    provisioningState String
    Provisioning state of the private endpoint connection.
    privateEndpoint Property Map
    The private endpoint which the connection belongs to.
    privateLinkServiceConnectionState Property Map
    Connection state of the private endpoint connection.

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    actionsRequired string
    The actions required for private link service connection.
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    actions_required str
    The actions required for private link service connection.
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:synapse:PrivateLinkHub privateLinkHub1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi