azure-native.hdinsight.PrivateEndpointConnection
Explore with Pulumi AI
The private endpoint connection. Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-06-01.
Other available API versions: 2023-04-15-preview, 2023-08-15-preview, 2024-08-01-preview.
Example Usage
Approve a private endpoint connection manually.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpointConnection = new AzureNative.HDInsight.PrivateEndpointConnection("privateEndpointConnection", new()
{
ClusterName = "cluster1",
PrivateEndpointConnectionName = "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
PrivateLinkServiceConnectionState = new AzureNative.HDInsight.Inputs.PrivateLinkServiceConnectionStateArgs
{
ActionsRequired = "None",
Description = "update it from pending to approved.",
Status = AzureNative.HDInsight.PrivateLinkServiceConnectionStatus.Approved,
},
ResourceGroupName = "rg1",
});
});
package main
import (
hdinsight "github.com/pulumi/pulumi-azure-native-sdk/hdinsight/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := hdinsight.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &hdinsight.PrivateEndpointConnectionArgs{
ClusterName: pulumi.String("cluster1"),
PrivateEndpointConnectionName: pulumi.String("testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2"),
PrivateLinkServiceConnectionState: &hdinsight.PrivateLinkServiceConnectionStateArgs{
ActionsRequired: pulumi.String("None"),
Description: pulumi.String("update it from pending to approved."),
Status: pulumi.String(hdinsight.PrivateLinkServiceConnectionStatusApproved),
},
ResourceGroupName: pulumi.String("rg1"),
})
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.hdinsight.PrivateEndpointConnection;
import com.pulumi.azurenative.hdinsight.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.hdinsight.inputs.PrivateLinkServiceConnectionStateArgs;
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()
.clusterName("cluster1")
.privateEndpointConnectionName("testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2")
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.actionsRequired("None")
.description("update it from pending to approved.")
.status("Approved")
.build())
.resourceGroupName("rg1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
private_endpoint_connection = azure_native.hdinsight.PrivateEndpointConnection("privateEndpointConnection",
cluster_name="cluster1",
private_endpoint_connection_name="testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
private_link_service_connection_state={
"actions_required": "None",
"description": "update it from pending to approved.",
"status": azure_native.hdinsight.PrivateLinkServiceConnectionStatus.APPROVED,
},
resource_group_name="rg1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const privateEndpointConnection = new azure_native.hdinsight.PrivateEndpointConnection("privateEndpointConnection", {
clusterName: "cluster1",
privateEndpointConnectionName: "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
privateLinkServiceConnectionState: {
actionsRequired: "None",
description: "update it from pending to approved.",
status: azure_native.hdinsight.PrivateLinkServiceConnectionStatus.Approved,
},
resourceGroupName: "rg1",
});
resources:
privateEndpointConnection:
type: azure-native:hdinsight:PrivateEndpointConnection
properties:
clusterName: cluster1
privateEndpointConnectionName: testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2
privateLinkServiceConnectionState:
actionsRequired: None
description: update it from pending to approved.
status: Approved
resourceGroupName: rg1
Create PrivateEndpointConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnection(resource_name: str,
args: PrivateEndpointConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
resource_group_name: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = 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:hdinsight:PrivateEndpointConnection
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 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 PrivateEndpointConnectionArgs
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleprivateEndpointConnectionResourceResourceFromHdinsight = new AzureNative.HDInsight.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight", new()
{
ClusterName = "string",
PrivateLinkServiceConnectionState = new AzureNative.HDInsight.Inputs.PrivateLinkServiceConnectionStateArgs
{
Status = "string",
ActionsRequired = "string",
Description = "string",
},
ResourceGroupName = "string",
PrivateEndpointConnectionName = "string",
});
example, err := hdinsight.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromHdinsight", &hdinsight.PrivateEndpointConnectionArgs{
ClusterName: pulumi.String("string"),
PrivateLinkServiceConnectionState: &hdinsight.PrivateLinkServiceConnectionStateArgs{
Status: pulumi.String("string"),
ActionsRequired: pulumi.String("string"),
Description: pulumi.String("string"),
},
ResourceGroupName: pulumi.String("string"),
PrivateEndpointConnectionName: pulumi.String("string"),
})
var exampleprivateEndpointConnectionResourceResourceFromHdinsight = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight", PrivateEndpointConnectionArgs.builder()
.clusterName("string")
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.status("string")
.actionsRequired("string")
.description("string")
.build())
.resourceGroupName("string")
.privateEndpointConnectionName("string")
.build());
exampleprivate_endpoint_connection_resource_resource_from_hdinsight = azure_native.hdinsight.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight",
cluster_name="string",
private_link_service_connection_state={
"status": "string",
"actionsRequired": "string",
"description": "string",
},
resource_group_name="string",
private_endpoint_connection_name="string")
const exampleprivateEndpointConnectionResourceResourceFromHdinsight = new azure_native.hdinsight.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight", {
clusterName: "string",
privateLinkServiceConnectionState: {
status: "string",
actionsRequired: "string",
description: "string",
},
resourceGroupName: "string",
privateEndpointConnectionName: "string",
});
type: azure-native:hdinsight:PrivateEndpointConnection
properties:
clusterName: string
privateEndpointConnectionName: string
privateLinkServiceConnectionState:
actionsRequired: string
description: string
status: string
resourceGroupName: string
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:
- Cluster
Name string - The name of the cluster.
- Private
Link Pulumi.Service Connection State Azure Native. HDInsight. Inputs. Private Link Service Connection State - The private link service connection state.
- Resource
Group stringName - The name of the resource group.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection.
- Cluster
Name string - The name of the cluster.
- Private
Link PrivateService Connection State Link Service Connection State Args - The private link service connection state.
- Resource
Group stringName - The name of the resource group.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection.
- cluster
Name String - The name of the cluster.
- private
Link PrivateService Connection State Link Service Connection State - The private link service connection state.
- resource
Group StringName - The name of the resource group.
- private
Endpoint StringConnection Name - The name of the private endpoint connection.
- cluster
Name string - The name of the cluster.
- private
Link PrivateService Connection State Link Service Connection State - The private link service connection state.
- resource
Group stringName - The name of the resource group.
- private
Endpoint stringConnection Name - The name of the private endpoint connection.
- cluster_
name str - The name of the cluster.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Args - The private link service connection state.
- resource_
group_ strname - The name of the resource group.
- private_
endpoint_ strconnection_ name - The name of the private endpoint connection.
- cluster
Name String - The name of the cluster.
- private
Link Property MapService Connection State - The private link service connection state.
- resource
Group StringName - The name of the resource group.
- private
Endpoint StringConnection Name - The name 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.
- Link
Identifier string - The link identifier.
- Name string
- The name of the resource
- Private
Endpoint Pulumi.Azure Native. HDInsight. Outputs. Private Endpoint Response - The private endpoint of the private endpoint connection
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data Pulumi.Azure Native. HDInsight. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- 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.
- Link
Identifier string - The link identifier.
- Name string
- The name of the resource
- Private
Endpoint PrivateEndpoint Response - The private endpoint of the private endpoint connection
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- 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.
- link
Identifier String - The link identifier.
- name String
- The name of the resource
- private
Endpoint PrivateEndpoint Response - The private endpoint of the private endpoint connection
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- 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.
- link
Identifier string - The link identifier.
- name string
- The name of the resource
- private
Endpoint PrivateEndpoint Response - The private endpoint of the private endpoint connection
- provisioning
State string - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- 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.
- link_
identifier str - The link identifier.
- name str
- The name of the resource
- private_
endpoint PrivateEndpoint Response - The private endpoint of the private endpoint connection
- provisioning_
state str - The provisioning state, which only appears in the response.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- 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.
- link
Identifier String - The link identifier.
- name String
- The name of the resource
- private
Endpoint Property Map - The private endpoint of the private endpoint connection
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
PrivateEndpointResponse, PrivateEndpointResponseArgs
- Id string
- The private endpoint id.
- Id string
- The private endpoint id.
- id String
- The private endpoint id.
- id string
- The private endpoint id.
- id str
- The private endpoint id.
- id String
- The private endpoint id.
PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs
- Status
string | Pulumi.
Azure Native. HDInsight. Private Link Service Connection Status - The concrete private link service connection.
- Actions
Required string - Whether there is further actions.
- Description string
- The optional description of the status.
- Status
string | Private
Link Service Connection Status - The concrete private link service connection.
- Actions
Required string - Whether there is further actions.
- Description string
- The optional description of the status.
- status
String | Private
Link Service Connection Status - The concrete private link service connection.
- actions
Required String - Whether there is further actions.
- description String
- The optional description of the status.
- status
string | Private
Link Service Connection Status - The concrete private link service connection.
- actions
Required string - Whether there is further actions.
- description string
- The optional description of the status.
- status
str | Private
Link Service Connection Status - The concrete private link service connection.
- actions_
required str - Whether there is further actions.
- description str
- The optional description of the status.
- status String | "Approved" | "Rejected" | "Pending" | "Removed"
- The concrete private link service connection.
- actions
Required String - Whether there is further actions.
- description String
- The optional description of the status.
PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs
- Status string
- The concrete private link service connection.
- Actions
Required string - Whether there is further actions.
- Description string
- The optional description of the status.
- Status string
- The concrete private link service connection.
- Actions
Required string - Whether there is further actions.
- Description string
- The optional description of the status.
- status String
- The concrete private link service connection.
- actions
Required String - Whether there is further actions.
- description String
- The optional description of the status.
- status string
- The concrete private link service connection.
- actions
Required string - Whether there is further actions.
- description string
- The optional description of the status.
- status str
- The concrete private link service connection.
- actions_
required str - Whether there is further actions.
- description str
- The optional description of the status.
- status String
- The concrete private link service connection.
- actions
Required String - Whether there is further actions.
- description String
- The optional description of the status.
PrivateLinkServiceConnectionStatus, PrivateLinkServiceConnectionStatusArgs
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Removed
- Removed
- Private
Link Service Connection Status Approved - Approved
- Private
Link Service Connection Status Rejected - Rejected
- Private
Link Service Connection Status Pending - Pending
- Private
Link Service Connection Status Removed - Removed
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Removed
- Removed
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Removed
- Removed
- APPROVED
- Approved
- REJECTED
- Rejected
- PENDING
- Pending
- REMOVED
- Removed
- "Approved"
- Approved
- "Rejected"
- Rejected
- "Pending"
- Pending
- "Removed"
- Removed
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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:hdinsight:PrivateEndpointConnection testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0