1. Packages
  2. Azure Native
  3. API Docs
  4. powerbi
  5. PrivateEndpointConnection
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.33.0 published on Friday, Mar 22, 2024 by Pulumi

azure-native.powerbi.PrivateEndpointConnection

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.33.0 published on Friday, Mar 22, 2024 by Pulumi

    Azure REST API version: 2020-06-01. Prior API version in Azure Native 1.x: 2020-06-01.

    Example Usage

    Updates status of private endpoint connection

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var privateEndpointConnection = new AzureNative.PowerBI.PrivateEndpointConnection("privateEndpointConnection", new()
        {
            AzureResourceName = "azureResourceName",
            PrivateEndpoint = new AzureNative.PowerBI.Inputs.PrivateEndpointArgs
            {
                Id = "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName",
            },
            PrivateEndpointName = "myPrivateEndpointName",
            PrivateLinkServiceConnectionState = new AzureNative.PowerBI.Inputs.ConnectionStateArgs
            {
                ActionsRequired = "None",
                Description = "",
                Status = "Approved ",
            },
            ResourceGroupName = "resourceGroup",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/powerbi/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := powerbi.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &powerbi.PrivateEndpointConnectionArgs{
    			AzureResourceName: pulumi.String("azureResourceName"),
    			PrivateEndpoint: &powerbi.PrivateEndpointArgs{
    				Id: pulumi.String("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName"),
    			},
    			PrivateEndpointName: pulumi.String("myPrivateEndpointName"),
    			PrivateLinkServiceConnectionState: &powerbi.ConnectionStateArgs{
    				ActionsRequired: pulumi.String("None"),
    				Description:     pulumi.String(""),
    				Status:          pulumi.String("Approved "),
    			},
    			ResourceGroupName: pulumi.String("resourceGroup"),
    		})
    		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.powerbi.PrivateEndpointConnection;
    import com.pulumi.azurenative.powerbi.PrivateEndpointConnectionArgs;
    import com.pulumi.azurenative.powerbi.inputs.PrivateEndpointArgs;
    import com.pulumi.azurenative.powerbi.inputs.ConnectionStateArgs;
    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 privateEndpointConnection = new PrivateEndpointConnection("privateEndpointConnection", PrivateEndpointConnectionArgs.builder()        
                .azureResourceName("azureResourceName")
                .privateEndpoint(PrivateEndpointArgs.builder()
                    .id("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName")
                    .build())
                .privateEndpointName("myPrivateEndpointName")
                .privateLinkServiceConnectionState(ConnectionStateArgs.builder()
                    .actionsRequired("None")
                    .description("")
                    .status("Approved ")
                    .build())
                .resourceGroupName("resourceGroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    private_endpoint_connection = azure_native.powerbi.PrivateEndpointConnection("privateEndpointConnection",
        azure_resource_name="azureResourceName",
        private_endpoint=azure_native.powerbi.PrivateEndpointArgs(
            id="/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName",
        ),
        private_endpoint_name="myPrivateEndpointName",
        private_link_service_connection_state=azure_native.powerbi.ConnectionStateArgs(
            actions_required="None",
            description="",
            status="Approved ",
        ),
        resource_group_name="resourceGroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const privateEndpointConnection = new azure_native.powerbi.PrivateEndpointConnection("privateEndpointConnection", {
        azureResourceName: "azureResourceName",
        privateEndpoint: {
            id: "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName",
        },
        privateEndpointName: "myPrivateEndpointName",
        privateLinkServiceConnectionState: {
            actionsRequired: "None",
            description: "",
            status: "Approved ",
        },
        resourceGroupName: "resourceGroup",
    });
    
    resources:
      privateEndpointConnection:
        type: azure-native:powerbi:PrivateEndpointConnection
        properties:
          azureResourceName: azureResourceName
          privateEndpoint:
            id: /subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName
          privateEndpointName: myPrivateEndpointName
          privateLinkServiceConnectionState:
            actionsRequired: None
            description:
            status: 'Approved '
          resourceGroupName: resourceGroup
    

    Create PrivateEndpointConnection Resource

    new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateEndpointConnection(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  azure_resource_name: Optional[str] = None,
                                  private_endpoint: Optional[PrivateEndpointArgs] = None,
                                  private_endpoint_name: Optional[str] = None,
                                  private_link_service_connection_state: Optional[ConnectionStateArgs] = None,
                                  provisioning_state: Optional[Union[str, ResourceProvisioningState]] = None,
                                  resource_group_name: Optional[str] = None)
    @overload
    def PrivateEndpointConnection(resource_name: str,
                                  args: PrivateEndpointConnectionInitArgs,
                                  opts: Optional[ResourceOptions] = None)
    func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)
    public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
    public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
    public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)
    
    type: azure-native:powerbi:PrivateEndpointConnection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    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 PrivateEndpointConnectionInitArgs
    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 PrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PrivateEndpointConnection Resource Properties

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

    Inputs

    The PrivateEndpointConnection resource accepts the following input properties:

    AzureResourceName string
    The name of the Azure resource.
    ResourceGroupName string
    The name of the resource group.
    PrivateEndpoint Pulumi.AzureNative.PowerBI.Inputs.PrivateEndpoint
    Specifies the private endpoint.
    PrivateEndpointName string
    The name of the private endpoint.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.PowerBI.Inputs.ConnectionState
    Specifies the connection state.
    ProvisioningState string | Pulumi.AzureNative.PowerBI.ResourceProvisioningState
    Provisioning state of the Private Endpoint Connection.
    AzureResourceName string
    The name of the Azure resource.
    ResourceGroupName string
    The name of the resource group.
    PrivateEndpoint PrivateEndpointArgs
    Specifies the private endpoint.
    PrivateEndpointName string
    The name of the private endpoint.
    PrivateLinkServiceConnectionState ConnectionStateArgs
    Specifies the connection state.
    ProvisioningState string | ResourceProvisioningState
    Provisioning state of the Private Endpoint Connection.
    azureResourceName String
    The name of the Azure resource.
    resourceGroupName String
    The name of the resource group.
    privateEndpoint PrivateEndpoint
    Specifies the private endpoint.
    privateEndpointName String
    The name of the private endpoint.
    privateLinkServiceConnectionState ConnectionState
    Specifies the connection state.
    provisioningState String | ResourceProvisioningState
    Provisioning state of the Private Endpoint Connection.
    azureResourceName string
    The name of the Azure resource.
    resourceGroupName string
    The name of the resource group.
    privateEndpoint PrivateEndpoint
    Specifies the private endpoint.
    privateEndpointName string
    The name of the private endpoint.
    privateLinkServiceConnectionState ConnectionState
    Specifies the connection state.
    provisioningState string | ResourceProvisioningState
    Provisioning state of the Private Endpoint Connection.
    azure_resource_name str
    The name of the Azure resource.
    resource_group_name str
    The name of the resource group.
    private_endpoint PrivateEndpointArgs
    Specifies the private endpoint.
    private_endpoint_name str
    The name of the private endpoint.
    private_link_service_connection_state ConnectionStateArgs
    Specifies the connection state.
    provisioning_state str | ResourceProvisioningState
    Provisioning state of the Private Endpoint Connection.
    azureResourceName String
    The name of the Azure resource.
    resourceGroupName String
    The name of the resource group.
    privateEndpoint Property Map
    Specifies the private endpoint.
    privateEndpointName String
    The name of the private endpoint.
    privateLinkServiceConnectionState Property Map
    Specifies the connection state.
    provisioningState String | "Creating" | "Updating" | "Deleting" | "Succeeded" | "Canceled" | "Failed"
    Provisioning state of the Private Endpoint Connection.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Specifies the name of the resource.
    SystemData Pulumi.AzureNative.PowerBI.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    Specifies the type of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Specifies the name of the resource.
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    Specifies the type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Specifies the name of the resource.
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    Specifies the type of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Specifies the name of the resource.
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    Specifies the type of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Specifies the name of the resource.
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    Specifies the type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Specifies the name of the resource.
    systemData Property Map
    The system meta data relating to this resource.
    type String
    Specifies the type of the resource.

    Supporting Types

    ConnectionState, ConnectionStateArgs

    ActionsRequired string
    Actions required (if any).
    Description string
    Description of the connection state.
    Status string | Pulumi.AzureNative.PowerBI.PersistedConnectionStatus
    Status of the connection.
    ActionsRequired string
    Actions required (if any).
    Description string
    Description of the connection state.
    Status string | PersistedConnectionStatus
    Status of the connection.
    actionsRequired String
    Actions required (if any).
    description String
    Description of the connection state.
    status String | PersistedConnectionStatus
    Status of the connection.
    actionsRequired string
    Actions required (if any).
    description string
    Description of the connection state.
    status string | PersistedConnectionStatus
    Status of the connection.
    actions_required str
    Actions required (if any).
    description str
    Description of the connection state.
    status str | PersistedConnectionStatus
    Status of the connection.
    actionsRequired String
    Actions required (if any).
    description String
    Description of the connection state.
    status String | "Pending" | "Approved" | "Rejected" | "Disconnected"
    Status of the connection.

    ConnectionStateResponse, ConnectionStateResponseArgs

    ActionsRequired string
    Actions required (if any).
    Description string
    Description of the connection state.
    Status string
    Status of the connection.
    ActionsRequired string
    Actions required (if any).
    Description string
    Description of the connection state.
    Status string
    Status of the connection.
    actionsRequired String
    Actions required (if any).
    description String
    Description of the connection state.
    status String
    Status of the connection.
    actionsRequired string
    Actions required (if any).
    description string
    Description of the connection state.
    status string
    Status of the connection.
    actions_required str
    Actions required (if any).
    description str
    Description of the connection state.
    status str
    Status of the connection.
    actionsRequired String
    Actions required (if any).
    description String
    Description of the connection state.
    status String
    Status of the connection.

    PersistedConnectionStatus, PersistedConnectionStatusArgs

    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PersistedConnectionStatusPending
    Pending
    PersistedConnectionStatusApproved
    Approved
    PersistedConnectionStatusRejected
    Rejected
    PersistedConnectionStatusDisconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PENDING
    Pending
    APPROVED
    Approved
    REJECTED
    Rejected
    DISCONNECTED
    Disconnected
    "Pending"
    Pending
    "Approved"
    Approved
    "Rejected"
    Rejected
    "Disconnected"
    Disconnected

    PrivateEndpoint, PrivateEndpointArgs

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

    PrivateEndpointResponse, PrivateEndpointResponseArgs

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

    ResourceProvisioningState, ResourceProvisioningStateArgs

    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    ResourceProvisioningStateCreating
    Creating
    ResourceProvisioningStateUpdating
    Updating
    ResourceProvisioningStateDeleting
    Deleting
    ResourceProvisioningStateSucceeded
    Succeeded
    ResourceProvisioningStateCanceled
    Canceled
    ResourceProvisioningStateFailed
    Failed
    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    CREATING
    Creating
    UPDATING
    Updating
    DELETING
    Deleting
    SUCCEEDED
    Succeeded
    CANCELED
    Canceled
    FAILED
    Failed
    "Creating"
    Creating
    "Updating"
    Updating
    "Deleting"
    Deleting
    "Succeeded"
    Succeeded
    "Canceled"
    Canceled
    "Failed"
    Failed

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:powerbi:PrivateEndpointConnection myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateEndpointConnections/{privateEndpointName} 
    

    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.33.0 published on Friday, Mar 22, 2024 by Pulumi