azure-native.hybridcompute.PrivateEndpointConnection
Explore with Pulumi AI
A private endpoint connection Azure REST API version: 2022-12-27. Prior API version in Azure Native 1.x: 2021-03-25-preview.
Other available API versions: 2020-08-15-preview, 2023-06-20-preview, 2023-10-03-preview, 2024-03-31-preview, 2024-05-20-preview, 2024-07-10, 2024-07-31-preview, 2024-09-10-preview, 2024-11-10-preview.
Example Usage
Approve or reject a private endpoint connection with a given name.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpointConnection = new AzureNative.HybridCompute.PrivateEndpointConnection("privateEndpointConnection", new()
{
PrivateEndpointConnectionName = "private-endpoint-connection-name",
Properties = new AzureNative.HybridCompute.Inputs.PrivateEndpointConnectionPropertiesArgs
{
PrivateLinkServiceConnectionState = new AzureNative.HybridCompute.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
{
Description = "Approved by johndoe@contoso.com",
Status = "Approved",
},
},
ResourceGroupName = "myResourceGroup",
ScopeName = "myPrivateLinkScope",
});
});
package main
import (
hybridcompute "github.com/pulumi/pulumi-azure-native-sdk/hybridcompute/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := hybridcompute.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &hybridcompute.PrivateEndpointConnectionArgs{
PrivateEndpointConnectionName: pulumi.String("private-endpoint-connection-name"),
Properties: &hybridcompute.PrivateEndpointConnectionPropertiesArgs{
PrivateLinkServiceConnectionState: &hybridcompute.PrivateLinkServiceConnectionStatePropertyArgs{
Description: pulumi.String("Approved by johndoe@contoso.com"),
Status: pulumi.String("Approved"),
},
},
ResourceGroupName: pulumi.String("myResourceGroup"),
ScopeName: pulumi.String("myPrivateLinkScope"),
})
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.hybridcompute.PrivateEndpointConnection;
import com.pulumi.azurenative.hybridcompute.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.hybridcompute.inputs.PrivateEndpointConnectionPropertiesArgs;
import com.pulumi.azurenative.hybridcompute.inputs.PrivateLinkServiceConnectionStatePropertyArgs;
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()
.privateEndpointConnectionName("private-endpoint-connection-name")
.properties(PrivateEndpointConnectionPropertiesArgs.builder()
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStatePropertyArgs.builder()
.description("Approved by johndoe@contoso.com")
.status("Approved")
.build())
.build())
.resourceGroupName("myResourceGroup")
.scopeName("myPrivateLinkScope")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
private_endpoint_connection = azure_native.hybridcompute.PrivateEndpointConnection("privateEndpointConnection",
private_endpoint_connection_name="private-endpoint-connection-name",
properties={
"private_link_service_connection_state": {
"description": "Approved by johndoe@contoso.com",
"status": "Approved",
},
},
resource_group_name="myResourceGroup",
scope_name="myPrivateLinkScope")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const privateEndpointConnection = new azure_native.hybridcompute.PrivateEndpointConnection("privateEndpointConnection", {
privateEndpointConnectionName: "private-endpoint-connection-name",
properties: {
privateLinkServiceConnectionState: {
description: "Approved by johndoe@contoso.com",
status: "Approved",
},
},
resourceGroupName: "myResourceGroup",
scopeName: "myPrivateLinkScope",
});
resources:
privateEndpointConnection:
type: azure-native:hybridcompute:PrivateEndpointConnection
properties:
privateEndpointConnectionName: private-endpoint-connection-name
properties:
privateLinkServiceConnectionState:
description: Approved by johndoe@contoso.com
status: Approved
resourceGroupName: myResourceGroup
scopeName: myPrivateLinkScope
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,
resource_group_name: Optional[str] = None,
scope_name: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = None,
properties: Optional[PrivateEndpointConnectionPropertiesArgs] = 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:hybridcompute: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 exampleprivateEndpointConnectionResourceResourceFromHybridcompute = new AzureNative.HybridCompute.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHybridcompute", new()
{
ResourceGroupName = "string",
ScopeName = "string",
PrivateEndpointConnectionName = "string",
Properties = new AzureNative.HybridCompute.Inputs.PrivateEndpointConnectionPropertiesArgs
{
PrivateEndpoint = new AzureNative.HybridCompute.Inputs.PrivateEndpointPropertyArgs
{
Id = "string",
},
PrivateLinkServiceConnectionState = new AzureNative.HybridCompute.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
{
Description = "string",
Status = "string",
},
},
});
example, err := hybridcompute.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromHybridcompute", &hybridcompute.PrivateEndpointConnectionArgs{
ResourceGroupName: pulumi.String("string"),
ScopeName: pulumi.String("string"),
PrivateEndpointConnectionName: pulumi.String("string"),
Properties: &hybridcompute.PrivateEndpointConnectionPropertiesArgs{
PrivateEndpoint: &hybridcompute.PrivateEndpointPropertyArgs{
Id: pulumi.String("string"),
},
PrivateLinkServiceConnectionState: &hybridcompute.PrivateLinkServiceConnectionStatePropertyArgs{
Description: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
})
var exampleprivateEndpointConnectionResourceResourceFromHybridcompute = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHybridcompute", PrivateEndpointConnectionArgs.builder()
.resourceGroupName("string")
.scopeName("string")
.privateEndpointConnectionName("string")
.properties(PrivateEndpointConnectionPropertiesArgs.builder()
.privateEndpoint(PrivateEndpointPropertyArgs.builder()
.id("string")
.build())
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStatePropertyArgs.builder()
.description("string")
.status("string")
.build())
.build())
.build());
exampleprivate_endpoint_connection_resource_resource_from_hybridcompute = azure_native.hybridcompute.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHybridcompute",
resource_group_name="string",
scope_name="string",
private_endpoint_connection_name="string",
properties={
"private_endpoint": {
"id": "string",
},
"private_link_service_connection_state": {
"description": "string",
"status": "string",
},
})
const exampleprivateEndpointConnectionResourceResourceFromHybridcompute = new azure_native.hybridcompute.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHybridcompute", {
resourceGroupName: "string",
scopeName: "string",
privateEndpointConnectionName: "string",
properties: {
privateEndpoint: {
id: "string",
},
privateLinkServiceConnectionState: {
description: "string",
status: "string",
},
},
});
type: azure-native:hybridcompute:PrivateEndpointConnection
properties:
privateEndpointConnectionName: string
properties:
privateEndpoint:
id: string
privateLinkServiceConnectionState:
description: string
status: string
resourceGroupName: string
scopeName: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PrivateEndpointConnection resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Scope
Name string - The name of the Azure Arc PrivateLinkScope resource.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection.
- Properties
Pulumi.
Azure Native. Hybrid Compute. Inputs. Private Endpoint Connection Properties - Resource properties.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Scope
Name string - The name of the Azure Arc PrivateLinkScope resource.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection.
- Properties
Private
Endpoint Connection Properties Args - Resource properties.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- scope
Name String - The name of the Azure Arc PrivateLinkScope resource.
- private
Endpoint StringConnection Name - The name of the private endpoint connection.
- properties
Private
Endpoint Connection Properties - Resource properties.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- scope
Name string - The name of the Azure Arc PrivateLinkScope resource.
- private
Endpoint stringConnection Name - The name of the private endpoint connection.
- properties
Private
Endpoint Connection Properties - Resource properties.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- scope_
name str - The name of the Azure Arc PrivateLinkScope resource.
- private_
endpoint_ strconnection_ name - The name of the private endpoint connection.
- properties
Private
Endpoint Connection Properties Args - Resource properties.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- scope
Name String - The name of the Azure Arc PrivateLinkScope resource.
- private
Endpoint StringConnection Name - The name of the private endpoint connection.
- properties Property Map
- Resource properties.
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
- The name of the resource
- System
Data Pulumi.Azure Native. Hybrid Compute. Outputs. System Data Response - 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"
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - 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"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data 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
PrivateEndpointConnectionProperties, PrivateEndpointConnectionPropertiesArgs
- Private
Endpoint Pulumi.Azure Native. Hybrid Compute. Inputs. Private Endpoint Property - Private endpoint which the connection belongs to.
- Private
Link Pulumi.Service Connection State Azure Native. Hybrid Compute. Inputs. Private Link Service Connection State Property - Connection state of the private endpoint connection.
- Private
Endpoint PrivateEndpoint Property - Private endpoint which the connection belongs to.
- Private
Link PrivateService Connection State Link Service Connection State Property - Connection state of the private endpoint connection.
- private
Endpoint PrivateEndpoint Property - Private endpoint which the connection belongs to.
- private
Link PrivateService Connection State Link Service Connection State Property - Connection state of the private endpoint connection.
- private
Endpoint PrivateEndpoint Property - Private endpoint which the connection belongs to.
- private
Link PrivateService Connection State Link Service Connection State Property - Connection state of the private endpoint connection.
- private_
endpoint PrivateEndpoint Property - Private endpoint which the connection belongs to.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Property - Connection state of the private endpoint connection.
- private
Endpoint Property Map - Private endpoint which the connection belongs to.
- private
Link Property MapService Connection State - Connection state of the private endpoint connection.
PrivateEndpointConnectionPropertiesResponse, PrivateEndpointConnectionPropertiesResponseArgs
- Group
Ids List<string> - List of group IDs.
- Provisioning
State string - State of the private endpoint connection.
- Private
Endpoint Pulumi.Azure Native. Hybrid Compute. Inputs. Private Endpoint Property Response - Private endpoint which the connection belongs to.
- Private
Link Pulumi.Service Connection State Azure Native. Hybrid Compute. Inputs. Private Link Service Connection State Property Response - Connection state of the private endpoint connection.
- Group
Ids []string - List of group IDs.
- Provisioning
State string - State of the private endpoint connection.
- Private
Endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- Private
Link PrivateService Connection State Link Service Connection State Property Response - Connection state of the private endpoint connection.
- group
Ids List<String> - List of group IDs.
- provisioning
State String - State of the private endpoint connection.
- private
Endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- private
Link PrivateService Connection State Link Service Connection State Property Response - Connection state of the private endpoint connection.
- group
Ids string[] - List of group IDs.
- provisioning
State string - State of the private endpoint connection.
- private
Endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- private
Link PrivateService Connection State Link Service Connection State Property Response - Connection state of the private endpoint connection.
- group_
ids Sequence[str] - List of group IDs.
- provisioning_
state str - State of the private endpoint connection.
- private_
endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Property Response - Connection state of the private endpoint connection.
- group
Ids List<String> - List of group IDs.
- provisioning
State String - State of the private endpoint connection.
- private
Endpoint Property Map - Private endpoint which the connection belongs to.
- private
Link Property MapService Connection State - Connection state of the private endpoint connection.
PrivateEndpointProperty, PrivateEndpointPropertyArgs
- 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.
PrivateEndpointPropertyResponse, PrivateEndpointPropertyResponseArgs
- 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.
PrivateLinkServiceConnectionStateProperty, PrivateLinkServiceConnectionStatePropertyArgs
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- description String
- The private link service connection description.
- status String
- The private link service connection status.
- description string
- The private link service connection description.
- status string
- The private link service connection status.
- description str
- The private link service connection description.
- status str
- The private link service connection status.
- description String
- The private link service connection description.
- status String
- The private link service connection status.
PrivateLinkServiceConnectionStatePropertyResponse, PrivateLinkServiceConnectionStatePropertyResponseArgs
- Actions
Required 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 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 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 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.
- actions
Required 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.
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:hybridcompute:PrivateEndpointConnection private-endpoint-connection-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/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