Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

PrivateEndpointConnectionByName

The Private Endpoint Connection resource. API Version: 2021-04-01-preview.

Example Usage

ApiManagementApproveOrRejectPrivateEndpointConnection

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var privateEndpointConnectionByName = new AzureNative.ApiManagement.PrivateEndpointConnectionByName("privateEndpointConnectionByName", new AzureNative.ApiManagement.PrivateEndpointConnectionByNameArgs
        {
            Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
            PrivateEndpointConnectionName = "privateEndpointConnectionName",
            Properties = new AzureNative.ApiManagement.Inputs.PrivateEndpointConnectionRequestPropertiesArgs
            {
                PrivateLinkServiceConnectionState = new AzureNative.ApiManagement.Inputs.PrivateLinkServiceConnectionStateArgs
                {
                    Description = "The Private Endpoint Connection is approved.",
                    Status = "Approved",
                },
            },
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewPrivateEndpointConnectionByName(ctx, "privateEndpointConnectionByName", &apimanagement.PrivateEndpointConnectionByNameArgs{
			Id:                            pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName"),
			PrivateEndpointConnectionName: pulumi.String("privateEndpointConnectionName"),
			Properties: &apimanagement.PrivateEndpointConnectionRequestPropertiesArgs{
				PrivateLinkServiceConnectionState: &apimanagement.PrivateLinkServiceConnectionStateArgs{
					Description: pulumi.String("The Private Endpoint Connection is approved."),
					Status:      pulumi.String("Approved"),
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var privateEndpointConnectionByName = new PrivateEndpointConnectionByName("privateEndpointConnectionByName", PrivateEndpointConnectionByNameArgs.builder()        
            .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName")
            .privateEndpointConnectionName("privateEndpointConnectionName")
            .properties(Map.of("privateLinkServiceConnectionState", Map.ofEntries(
                Map.entry("description", "The Private Endpoint Connection is approved."),
                Map.entry("status", "Approved")
            )))
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection_by_name = azure_native.apimanagement.PrivateEndpointConnectionByName("privateEndpointConnectionByName",
    id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
    private_endpoint_connection_name="privateEndpointConnectionName",
    properties=azure_native.apimanagement.PrivateEndpointConnectionRequestPropertiesArgs(
        private_link_service_connection_state=azure_native.apimanagement.PrivateLinkServiceConnectionStateArgs(
            description="The Private Endpoint Connection is approved.",
            status="Approved",
        ),
    ),
    resource_group_name="rg1",
    service_name="apimService1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpointConnectionByName = new azure_native.apimanagement.PrivateEndpointConnectionByName("privateEndpointConnectionByName", {
    id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
    privateEndpointConnectionName: "privateEndpointConnectionName",
    properties: {
        privateLinkServiceConnectionState: {
            description: "The Private Endpoint Connection is approved.",
            status: "Approved",
        },
    },
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});
resources:
  privateEndpointConnectionByName:
    type: azure-native:apimanagement:PrivateEndpointConnectionByName
    properties:
      id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName
      privateEndpointConnectionName: privateEndpointConnectionName
      properties:
        privateLinkServiceConnectionState:
          description: The Private Endpoint Connection is approved.
          status: Approved
      resourceGroupName: rg1
      serviceName: apimService1

Create a PrivateEndpointConnectionByName Resource

new PrivateEndpointConnectionByName(name: string, args: PrivateEndpointConnectionByNameArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnectionByName(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    id: Optional[str] = None,
                                    private_endpoint_connection_name: Optional[str] = None,
                                    properties: Optional[PrivateEndpointConnectionRequestPropertiesArgs] = None,
                                    resource_group_name: Optional[str] = None,
                                    service_name: Optional[str] = None)
@overload
def PrivateEndpointConnectionByName(resource_name: str,
                                    args: PrivateEndpointConnectionByNameArgs,
                                    opts: Optional[ResourceOptions] = None)
func NewPrivateEndpointConnectionByName(ctx *Context, name string, args PrivateEndpointConnectionByNameArgs, opts ...ResourceOption) (*PrivateEndpointConnectionByName, error)
public PrivateEndpointConnectionByName(string name, PrivateEndpointConnectionByNameArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointConnectionByName(String name, PrivateEndpointConnectionByNameArgs args)
public PrivateEndpointConnectionByName(String name, PrivateEndpointConnectionByNameArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:PrivateEndpointConnectionByName
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args PrivateEndpointConnectionByNameArgs
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 PrivateEndpointConnectionByNameArgs
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 PrivateEndpointConnectionByNameArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PrivateEndpointConnectionByNameArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args PrivateEndpointConnectionByNameArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Id string

Private Endpoint Connection Resource Id.

PrivateEndpointConnectionName string

Name of the private endpoint connection.

Properties Pulumi.AzureNative.ApiManagement.Inputs.PrivateEndpointConnectionRequestPropertiesArgs

The connection state of the private endpoint connection.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Id string

Private Endpoint Connection Resource Id.

PrivateEndpointConnectionName string

Name of the private endpoint connection.

Properties PrivateEndpointConnectionRequestPropertiesArgs

The connection state of the private endpoint connection.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

id String

Private Endpoint Connection Resource Id.

privateEndpointConnectionName String

Name of the private endpoint connection.

properties PrivateEndpointConnectionRequestPropertiesArgs

The connection state of the private endpoint connection.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

id string

Private Endpoint Connection Resource Id.

privateEndpointConnectionName string

Name of the private endpoint connection.

properties PrivateEndpointConnectionRequestPropertiesArgs

The connection state of the private endpoint connection.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

id str

Private Endpoint Connection Resource Id.

private_endpoint_connection_name str

Name of the private endpoint connection.

properties PrivateEndpointConnectionRequestPropertiesArgs

The connection state of the private endpoint connection.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

id String

Private Endpoint Connection Resource Id.

privateEndpointConnectionName String

Name of the private endpoint connection.

properties Property Map

The connection state of the private endpoint connection.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource

PrivateLinkServiceConnectionState Pulumi.AzureNative.ApiManagement.Outputs.PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState string

The provisioning state of the private endpoint connection resource.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpoint Pulumi.AzureNative.ApiManagement.Outputs.PrivateEndpointResponse

The resource of private end point.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState string

The provisioning state of the private endpoint connection resource.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpoint PrivateEndpointResponse

The resource of private end point.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the resource

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

provisioningState String

The provisioning state of the private endpoint connection resource.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

privateEndpoint PrivateEndpointResponse

The resource of private end point.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the resource

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

provisioningState string

The provisioning state of the private endpoint connection resource.

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

privateEndpoint PrivateEndpointResponse

The resource of private end point.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the resource

private_link_service_connection_state PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

provisioning_state str

The provisioning state of the private endpoint connection resource.

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

private_endpoint PrivateEndpointResponse

The resource of private end point.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the resource

privateLinkServiceConnectionState Property Map

A collection of information about the state of the connection between service consumer and provider.

provisioningState String

The provisioning state of the private endpoint connection resource.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

privateEndpoint Property Map

The resource of private end point.

Supporting Types

PrivateEndpointConnectionRequestProperties

PrivateLinkServiceConnectionState Pulumi.AzureNative.ApiManagement.Inputs.PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

privateLinkServiceConnectionState PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

privateLinkServiceConnectionState PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

private_link_service_connection_state PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

privateLinkServiceConnectionState Property Map

A collection of information about the state of the connection between service consumer and provider.

PrivateEndpointResponse

Id string

The ARM identifier for Private Endpoint

Id string

The ARM identifier for Private Endpoint

id String

The ARM identifier for Private Endpoint

id string

The ARM identifier for Private Endpoint

id str

The ARM identifier for Private Endpoint

id String

The ARM identifier for Private Endpoint

PrivateEndpointServiceConnectionStatus

Pending
Pending
Approved
Approved
Rejected
Rejected
PrivateEndpointServiceConnectionStatusPending
Pending
PrivateEndpointServiceConnectionStatusApproved
Approved
PrivateEndpointServiceConnectionStatusRejected
Rejected
Pending
Pending
Approved
Approved
Rejected
Rejected
Pending
Pending
Approved
Approved
Rejected
Rejected
PENDING
Pending
APPROVED
Approved
REJECTED
Rejected
"Pending"
Pending
"Approved"
Approved
"Rejected"
Rejected

PrivateLinkServiceConnectionState

ActionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

Description string

The reason for approval/rejection of the connection.

Status string | Pulumi.AzureNative.ApiManagement.PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ActionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

Description string

The reason for approval/rejection of the connection.

Status string | PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String

A message indicating if changes on the service provider require any updates on the consumer.

description String

The reason for approval/rejection of the connection.

status String | PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

description string

The reason for approval/rejection of the connection.

status string | PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actions_required str

A message indicating if changes on the service provider require any updates on the consumer.

description str

The reason for approval/rejection of the connection.

status str | PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String

A message indicating if changes on the service provider require any updates on the consumer.

description String

The reason for approval/rejection of the connection.

status String | "Pending" | "Approved" | "Rejected"

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

PrivateLinkServiceConnectionStateResponse

ActionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

Description string

The reason for approval/rejection of the connection.

Status string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ActionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

Description string

The reason for approval/rejection of the connection.

Status string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String

A message indicating if changes on the service provider require any updates on the consumer.

description String

The reason for approval/rejection of the connection.

status String

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

description string

The reason for approval/rejection of the connection.

status string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actions_required str

A message indicating if changes on the service provider require any updates on the consumer.

description str

The reason for approval/rejection of the connection.

status str

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String

A message indicating if changes on the service provider require any updates on the consumer.

description String

The reason for approval/rejection of the connection.

status String

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Import

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

$ pulumi import azure-native:apimanagement:PrivateEndpointConnectionByName privateEndpointConnectionName /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0