azure-native.apimanagement.PrivateEndpointConnectionByName
Explore with Pulumi AI
The Private Endpoint Connection resource. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2021-04-01-preview.
Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementApproveOrRejectPrivateEndpointConnection
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpointConnectionByName = new AzureNative.ApiManagement.PrivateEndpointConnectionByName("privateEndpointConnectionByName", new()
{
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 = AzureNative.ApiManagement.PrivateEndpointServiceConnectionStatus.Approved,
},
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"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(apimanagement.PrivateEndpointServiceConnectionStatusApproved),
},
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
})
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.apimanagement.PrivateEndpointConnectionByName;
import com.pulumi.azurenative.apimanagement.PrivateEndpointConnectionByNameArgs;
import com.pulumi.azurenative.apimanagement.inputs.PrivateEndpointConnectionRequestPropertiesArgs;
import com.pulumi.azurenative.apimanagement.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 privateEndpointConnectionByName = new PrivateEndpointConnectionByName("privateEndpointConnectionByName", PrivateEndpointConnectionByNameArgs.builder()
.id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName")
.privateEndpointConnectionName("privateEndpointConnectionName")
.properties(PrivateEndpointConnectionRequestPropertiesArgs.builder()
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.description("The Private Endpoint Connection is approved.")
.status("Approved")
.build())
.build())
.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={
"private_link_service_connection_state": {
"description": "The Private Endpoint Connection is approved.",
"status": azure_native.apimanagement.PrivateEndpointServiceConnectionStatus.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: azure_native.apimanagement.PrivateEndpointServiceConnectionStatus.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 PrivateEndpointConnectionByName Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivateEndpointConnectionByName(name: string, args: PrivateEndpointConnectionByNameArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnectionByName(resource_name: str,
args: PrivateEndpointConnectionByNameArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PrivateEndpointConnectionByName(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
id: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = None,
properties: Optional[PrivateEndpointConnectionRequestPropertiesArgs] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var privateEndpointConnectionByNameResource = new AzureNative.ApiManagement.PrivateEndpointConnectionByName("privateEndpointConnectionByNameResource", new()
{
ResourceGroupName = "string",
ServiceName = "string",
Id = "string",
PrivateEndpointConnectionName = "string",
Properties = new AzureNative.ApiManagement.Inputs.PrivateEndpointConnectionRequestPropertiesArgs
{
PrivateLinkServiceConnectionState = new AzureNative.ApiManagement.Inputs.PrivateLinkServiceConnectionStateArgs
{
ActionsRequired = "string",
Description = "string",
Status = "string",
},
},
});
example, err := apimanagement.NewPrivateEndpointConnectionByName(ctx, "privateEndpointConnectionByNameResource", &apimanagement.PrivateEndpointConnectionByNameArgs{
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Id: pulumi.String("string"),
PrivateEndpointConnectionName: pulumi.String("string"),
Properties: &apimanagement.PrivateEndpointConnectionRequestPropertiesArgs{
PrivateLinkServiceConnectionState: &apimanagement.PrivateLinkServiceConnectionStateArgs{
ActionsRequired: pulumi.String("string"),
Description: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
})
var privateEndpointConnectionByNameResource = new PrivateEndpointConnectionByName("privateEndpointConnectionByNameResource", PrivateEndpointConnectionByNameArgs.builder()
.resourceGroupName("string")
.serviceName("string")
.id("string")
.privateEndpointConnectionName("string")
.properties(PrivateEndpointConnectionRequestPropertiesArgs.builder()
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.actionsRequired("string")
.description("string")
.status("string")
.build())
.build())
.build());
private_endpoint_connection_by_name_resource = azure_native.apimanagement.PrivateEndpointConnectionByName("privateEndpointConnectionByNameResource",
resource_group_name="string",
service_name="string",
id="string",
private_endpoint_connection_name="string",
properties={
"private_link_service_connection_state": {
"actions_required": "string",
"description": "string",
"status": "string",
},
})
const privateEndpointConnectionByNameResource = new azure_native.apimanagement.PrivateEndpointConnectionByName("privateEndpointConnectionByNameResource", {
resourceGroupName: "string",
serviceName: "string",
id: "string",
privateEndpointConnectionName: "string",
properties: {
privateLinkServiceConnectionState: {
actionsRequired: "string",
description: "string",
status: "string",
},
},
});
type: azure-native:apimanagement:PrivateEndpointConnectionByName
properties:
id: string
privateEndpointConnectionName: string
properties:
privateLinkServiceConnectionState:
actionsRequired: string
description: string
status: string
resourceGroupName: string
serviceName: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PrivateEndpointConnectionByName resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Id string
- Private Endpoint Connection Resource Id.
- Private
Endpoint stringConnection Name - Name of the private endpoint connection.
- Properties
Pulumi.
Azure Native. Api Management. Inputs. Private Endpoint Connection Request Properties - The connection state of the private endpoint connection.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Id string
- Private Endpoint Connection Resource Id.
- Private
Endpoint stringConnection Name - Name of the private endpoint connection.
- Properties
Private
Endpoint Connection Request Properties Args - The connection state of the private endpoint connection.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- id String
- Private Endpoint Connection Resource Id.
- private
Endpoint StringConnection Name - Name of the private endpoint connection.
- properties
Private
Endpoint Connection Request Properties - The connection state of the private endpoint connection.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- id string
- Private Endpoint Connection Resource Id.
- private
Endpoint stringConnection Name - Name of the private endpoint connection.
- properties
Private
Endpoint Connection Request Properties - The connection state of the private endpoint connection.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- id str
- Private Endpoint Connection Resource Id.
- private_
endpoint_ strconnection_ name - Name of the private endpoint connection.
- properties
Private
Endpoint Connection Request Properties Args - The connection state of the private endpoint connection.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- id String
- Private Endpoint Connection Resource Id.
- private
Endpoint StringConnection Name - 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
- Private
Link Pulumi.Service Connection State Azure Native. Api Management. Outputs. Private Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State 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"
- Private
Endpoint Pulumi.Azure Native. Api Management. Outputs. Private Endpoint Response - The resource of private end point.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State 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"
- Private
Endpoint PrivateEndpoint Response - The resource of private end point.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State 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"
- private
Endpoint PrivateEndpoint Response - The resource of private end point.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State 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"
- private
Endpoint PrivateEndpoint Response - 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_ Privateservice_ connection_ state Link Service Connection State Response - 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 PrivateEndpoint Response - The resource of private end point.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Link Property MapService Connection State - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State 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"
- private
Endpoint Property Map - The resource of private end point.
Supporting Types
PrivateEndpointConnectionRequestProperties, PrivateEndpointConnectionRequestPropertiesArgs
- Private
Link Pulumi.Service Connection State Azure Native. Api Management. Inputs. Private Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- Private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private_
link_ Privateservice_ connection_ state Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private
Link Property MapService Connection State - A collection of information about the state of the connection between service consumer and provider.
PrivateEndpointResponse, PrivateEndpointResponseArgs
- 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, PrivateEndpointServiceConnectionStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Private
Endpoint Service Connection Status Pending - Pending
- Private
Endpoint Service Connection Status Approved - Approved
- Private
Endpoint Service Connection Status Rejected - 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, PrivateLinkServiceConnectionStateArgs
- Actions
Required 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.
Azure Native. Api Management. Private Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required 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 | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required 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 | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required 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 | Private
Endpoint Service Connection Status - 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 | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required 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, PrivateLinkServiceConnectionStateResponseArgs
- Actions
Required 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 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 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 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.
- actions
Required 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/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