Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. dashboard
  5. ManagedPrivateEndpoint
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.39.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.dashboard.ManagedPrivateEndpoint

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.39.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure-native

    The managed private endpoint resource type. Azure REST API version: 2022-10-01-preview.

    Other available API versions: 2023-09-01.

    Example Usage

    ManagedPrivateEndpoint_Create

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var managedPrivateEndpoint = new AzureNative.Dashboard.ManagedPrivateEndpoint("managedPrivateEndpoint", new()
    {
        GroupIds = new[]
        {
            "grafana",
        },
        Location = "West US",
        ManagedPrivateEndpointName = "myMPEName",
        PrivateLinkResourceId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource",
        PrivateLinkResourceRegion = "West US",
        PrivateLinkServiceUrl = "my-self-hosted-influxdb.westus.mydomain.com",
        RequestMessage = "Example Request Message",
        ResourceGroupName = "myResourceGroup",
        WorkspaceName = "myWorkspace",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-azure-native-sdk/dashboard/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dashboard.NewManagedPrivateEndpoint(ctx, "managedPrivateEndpoint", &dashboard.ManagedPrivateEndpointArgs{
			GroupIds: pulumi.StringArray{
				pulumi.String("grafana"),
			},
			Location:                   pulumi.String("West US"),
			ManagedPrivateEndpointName: pulumi.String("myMPEName"),
			PrivateLinkResourceId:      pulumi.String("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource"),
			PrivateLinkResourceRegion:  pulumi.String("West US"),
			PrivateLinkServiceUrl:      pulumi.String("my-self-hosted-influxdb.westus.mydomain.com"),
			RequestMessage:             pulumi.String("Example Request Message"),
			ResourceGroupName:          pulumi.String("myResourceGroup"),
			WorkspaceName:              pulumi.String("myWorkspace"),
		})
		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.dashboard.ManagedPrivateEndpoint;
import com.pulumi.azurenative.dashboard.ManagedPrivateEndpointArgs;
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 managedPrivateEndpoint = new ManagedPrivateEndpoint("managedPrivateEndpoint", ManagedPrivateEndpointArgs.builder()        
            .groupIds("grafana")
            .location("West US")
            .managedPrivateEndpointName("myMPEName")
            .privateLinkResourceId("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource")
            .privateLinkResourceRegion("West US")
            .privateLinkServiceUrl("my-self-hosted-influxdb.westus.mydomain.com")
            .requestMessage("Example Request Message")
            .resourceGroupName("myResourceGroup")
            .workspaceName("myWorkspace")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

managed_private_endpoint = azure_native.dashboard.ManagedPrivateEndpoint("managedPrivateEndpoint",
    group_ids=["grafana"],
    location="West US",
    managed_private_endpoint_name="myMPEName",
    private_link_resource_id="/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource",
    private_link_resource_region="West US",
    private_link_service_url="my-self-hosted-influxdb.westus.mydomain.com",
    request_message="Example Request Message",
    resource_group_name="myResourceGroup",
    workspace_name="myWorkspace")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const managedPrivateEndpoint = new azure_native.dashboard.ManagedPrivateEndpoint("managedPrivateEndpoint", {
    groupIds: ["grafana"],
    location: "West US",
    managedPrivateEndpointName: "myMPEName",
    privateLinkResourceId: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource",
    privateLinkResourceRegion: "West US",
    privateLinkServiceUrl: "my-self-hosted-influxdb.westus.mydomain.com",
    requestMessage: "Example Request Message",
    resourceGroupName: "myResourceGroup",
    workspaceName: "myWorkspace",
});

    resources:
  managedPrivateEndpoint:
    type: azure-native:dashboard:ManagedPrivateEndpoint
    properties:
      groupIds:
        - grafana
      location: West US
      managedPrivateEndpointName: myMPEName
      privateLinkResourceId: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource
      privateLinkResourceRegion: West US
      privateLinkServiceUrl: my-self-hosted-influxdb.westus.mydomain.com
      requestMessage: Example Request Message
      resourceGroupName: myResourceGroup
      workspaceName: myWorkspace

    Create ManagedPrivateEndpoint Resource

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

    Constructor syntax

    new ManagedPrivateEndpoint(name: string, args: ManagedPrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
def ManagedPrivateEndpoint(resource_name: str,
                           args: ManagedPrivateEndpointArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def ManagedPrivateEndpoint(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           resource_group_name: Optional[str] = None,
                           workspace_name: Optional[str] = None,
                           group_ids: Optional[Sequence[str]] = None,
                           location: Optional[str] = None,
                           managed_private_endpoint_name: Optional[str] = None,
                           private_link_resource_id: Optional[str] = None,
                           private_link_resource_region: Optional[str] = None,
                           private_link_service_url: Optional[str] = None,
                           request_message: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None)
    func NewManagedPrivateEndpoint(ctx *Context, name string, args ManagedPrivateEndpointArgs, opts ...ResourceOption) (*ManagedPrivateEndpoint, error)
    public ManagedPrivateEndpoint(string name, ManagedPrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public ManagedPrivateEndpoint(String name, ManagedPrivateEndpointArgs args)
public ManagedPrivateEndpoint(String name, ManagedPrivateEndpointArgs args, CustomResourceOptions options)

    type: azure-native:dashboard:ManagedPrivateEndpoint
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 ManagedPrivateEndpointArgs
    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 ManagedPrivateEndpointArgs
    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 ManagedPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagedPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagedPrivateEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var managedPrivateEndpointResource = new AzureNative.Dashboard.ManagedPrivateEndpoint("managedPrivateEndpointResource", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    GroupIds = new[]
    {
        "string",
    },
    Location = "string",
    ManagedPrivateEndpointName = "string",
    PrivateLinkResourceId = "string",
    PrivateLinkResourceRegion = "string",
    PrivateLinkServiceUrl = "string",
    RequestMessage = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := dashboard.NewManagedPrivateEndpoint(ctx, "managedPrivateEndpointResource", &dashboard.ManagedPrivateEndpointArgs{
ResourceGroupName: pulumi.String("string"),
WorkspaceName: pulumi.String("string"),
GroupIds: pulumi.StringArray{
pulumi.String("string"),
},
Location: pulumi.String("string"),
ManagedPrivateEndpointName: pulumi.String("string"),
PrivateLinkResourceId: pulumi.String("string"),
PrivateLinkResourceRegion: pulumi.String("string"),
PrivateLinkServiceUrl: pulumi.String("string"),
RequestMessage: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})

    var managedPrivateEndpointResource = new ManagedPrivateEndpoint("managedPrivateEndpointResource", ManagedPrivateEndpointArgs.builder()        
    .resourceGroupName("string")
    .workspaceName("string")
    .groupIds("string")
    .location("string")
    .managedPrivateEndpointName("string")
    .privateLinkResourceId("string")
    .privateLinkResourceRegion("string")
    .privateLinkServiceUrl("string")
    .requestMessage("string")
    .tags(Map.of("string", "string"))
    .build());

    managed_private_endpoint_resource = azure_native.dashboard.ManagedPrivateEndpoint("managedPrivateEndpointResource",
    resource_group_name="string",
    workspace_name="string",
    group_ids=["string"],
    location="string",
    managed_private_endpoint_name="string",
    private_link_resource_id="string",
    private_link_resource_region="string",
    private_link_service_url="string",
    request_message="string",
    tags={
        "string": "string",
    })

    const managedPrivateEndpointResource = new azure_native.dashboard.ManagedPrivateEndpoint("managedPrivateEndpointResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    groupIds: ["string"],
    location: "string",
    managedPrivateEndpointName: "string",
    privateLinkResourceId: "string",
    privateLinkResourceRegion: "string",
    privateLinkServiceUrl: "string",
    requestMessage: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:dashboard:ManagedPrivateEndpoint
properties:
    groupIds:
        - string
    location: string
    managedPrivateEndpointName: string
    privateLinkResourceId: string
    privateLinkResourceRegion: string
    privateLinkServiceUrl: string
    requestMessage: string
    resourceGroupName: string
    tags:
        string: string
    workspaceName: string

    ManagedPrivateEndpoint 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 ManagedPrivateEndpoint resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The workspace name of Azure Managed Grafana.
    GroupIds List<string>
    The group Ids of the managed private endpoint.
    Location string
    The geo-location where the resource lives
    ManagedPrivateEndpointName string
    The managed private endpoint name of Azure Managed Grafana.
    PrivateLinkResourceId string
    The ARM resource ID of the resource for which the managed private endpoint is pointing to.
    PrivateLinkResourceRegion string
    The region of the resource to which the managed private endpoint is pointing to.
    PrivateLinkServiceUrl string
    The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
    RequestMessage string
    User input request message of the managed private endpoint.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The workspace name of Azure Managed Grafana.
    GroupIds []string
    The group Ids of the managed private endpoint.
    Location string
    The geo-location where the resource lives
    ManagedPrivateEndpointName string
    The managed private endpoint name of Azure Managed Grafana.
    PrivateLinkResourceId string
    The ARM resource ID of the resource for which the managed private endpoint is pointing to.
    PrivateLinkResourceRegion string
    The region of the resource to which the managed private endpoint is pointing to.
    PrivateLinkServiceUrl string
    The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
    RequestMessage string
    User input request message of the managed private endpoint.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The workspace name of Azure Managed Grafana.
    groupIds List<String>
    The group Ids of the managed private endpoint.
    location String
    The geo-location where the resource lives
    managedPrivateEndpointName String
    The managed private endpoint name of Azure Managed Grafana.
    privateLinkResourceId String
    The ARM resource ID of the resource for which the managed private endpoint is pointing to.
    privateLinkResourceRegion String
    The region of the resource to which the managed private endpoint is pointing to.
    privateLinkServiceUrl String
    The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
    requestMessage String
    User input request message of the managed private endpoint.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The workspace name of Azure Managed Grafana.
    groupIds string[]
    The group Ids of the managed private endpoint.
    location string
    The geo-location where the resource lives
    managedPrivateEndpointName string
    The managed private endpoint name of Azure Managed Grafana.
    privateLinkResourceId string
    The ARM resource ID of the resource for which the managed private endpoint is pointing to.
    privateLinkResourceRegion string
    The region of the resource to which the managed private endpoint is pointing to.
    privateLinkServiceUrl string
    The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
    requestMessage string
    User input request message of the managed private endpoint.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The workspace name of Azure Managed Grafana.
    group_ids Sequence[str]
    The group Ids of the managed private endpoint.
    location str
    The geo-location where the resource lives
    managed_private_endpoint_name str
    The managed private endpoint name of Azure Managed Grafana.
    private_link_resource_id str
    The ARM resource ID of the resource for which the managed private endpoint is pointing to.
    private_link_resource_region str
    The region of the resource to which the managed private endpoint is pointing to.
    private_link_service_url str
    The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
    request_message str
    User input request message of the managed private endpoint.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The workspace name of Azure Managed Grafana.
    groupIds List<String>
    The group Ids of the managed private endpoint.
    location String
    The geo-location where the resource lives
    managedPrivateEndpointName String
    The managed private endpoint name of Azure Managed Grafana.
    privateLinkResourceId String
    The ARM resource ID of the resource for which the managed private endpoint is pointing to.
    privateLinkResourceRegion String
    The region of the resource to which the managed private endpoint is pointing to.
    privateLinkServiceUrl String
    The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
    requestMessage String
    User input request message of the managed private endpoint.
    tags Map<String>
    Resource tags.

    Outputs

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

    ConnectionState Pulumi.AzureNative.Dashboard.Outputs.ManagedPrivateEndpointConnectionStateResponse
    The state of managed private endpoint connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    PrivateLinkServicePrivateIP string
    The private IP of private endpoint after approval. This property is empty before connection is approved.
    ProvisioningState string
    Provisioning state of the resource.
    SystemData Pulumi.AzureNative.Dashboard.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ConnectionState ManagedPrivateEndpointConnectionStateResponse
    The state of managed private endpoint connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    PrivateLinkServicePrivateIP string
    The private IP of private endpoint after approval. This property is empty before connection is approved.
    ProvisioningState string
    Provisioning state of the resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    connectionState ManagedPrivateEndpointConnectionStateResponse
    The state of managed private endpoint connection.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    privateLinkServicePrivateIP String
    The private IP of private endpoint after approval. This property is empty before connection is approved.
    provisioningState String
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    connectionState ManagedPrivateEndpointConnectionStateResponse
    The state of managed private endpoint connection.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    privateLinkServicePrivateIP string
    The private IP of private endpoint after approval. This property is empty before connection is approved.
    provisioningState string
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    connection_state ManagedPrivateEndpointConnectionStateResponse
    The state of managed private endpoint connection.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    private_link_service_private_ip str
    The private IP of private endpoint after approval. This property is empty before connection is approved.
    provisioning_state str
    Provisioning state of the resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    connectionState Property Map
    The state of managed private endpoint connection.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    privateLinkServicePrivateIP String
    The private IP of private endpoint after approval. This property is empty before connection is approved.
    provisioningState String
    Provisioning state of the resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    ManagedPrivateEndpointConnectionStateResponse, ManagedPrivateEndpointConnectionStateResponseArgs

    Description string
    Gets or sets the reason for approval/rejection of the connection.
    Status string
    The approval/rejection status of managed private endpoint connection.
    Description string
    Gets or sets the reason for approval/rejection of the connection.
    Status string
    The approval/rejection status of managed private endpoint connection.
    description String
    Gets or sets the reason for approval/rejection of the connection.
    status String
    The approval/rejection status of managed private endpoint connection.
    description string
    Gets or sets the reason for approval/rejection of the connection.
    status string
    The approval/rejection status of managed private endpoint connection.
    description str
    Gets or sets the reason for approval/rejection of the connection.
    status str
    The approval/rejection status of managed private endpoint connection.
    description String
    Gets or sets the reason for approval/rejection of the connection.
    status String
    The approval/rejection status of managed private endpoint connection.

    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:dashboard:ManagedPrivateEndpoint myMPEName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}

    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.39.0 published on Monday, Apr 29, 2024 by Pulumi
    pulumi/pulumi-azure-native