1. Packages
  2. Azure Native v1
  3. API Docs
  4. cognitiveservices
  5. PrivateEndpointConnection
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.cognitiveservices.PrivateEndpointConnection

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    The Private Endpoint Connection resource. API Version: 2017-04-18.

    Example Usage

    PutPrivateEndpointConnection

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var privateEndpointConnection = new AzureNative.CognitiveServices.PrivateEndpointConnection("privateEndpointConnection", new()
        {
            AccountName = "sto9699",
            PrivateEndpointConnectionName = "{privateEndpointConnectionName}",
            Properties = new AzureNative.CognitiveServices.Inputs.PrivateEndpointConnectionPropertiesArgs
            {
                PrivateLinkServiceConnectionState = new AzureNative.CognitiveServices.Inputs.PrivateLinkServiceConnectionStateArgs
                {
                    Description = "Auto-Approved",
                    Status = "Approved",
                },
            },
            ResourceGroupName = "res7687",
        });
    
    });
    
    package main
    
    import (
    	cognitiveservices "github.com/pulumi/pulumi-azure-native-sdk/cognitiveservices"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cognitiveservices.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &cognitiveservices.PrivateEndpointConnectionArgs{
    			AccountName:                   pulumi.String("sto9699"),
    			PrivateEndpointConnectionName: pulumi.String("{privateEndpointConnectionName}"),
    			Properties: cognitiveservices.PrivateEndpointConnectionPropertiesResponse{
    				PrivateLinkServiceConnectionState: &cognitiveservices.PrivateLinkServiceConnectionStateArgs{
    					Description: pulumi.String("Auto-Approved"),
    					Status:      pulumi.String("Approved"),
    				},
    			},
    			ResourceGroupName: pulumi.String("res7687"),
    		})
    		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.cognitiveservices.PrivateEndpointConnection;
    import com.pulumi.azurenative.cognitiveservices.PrivateEndpointConnectionArgs;
    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()        
                .accountName("sto9699")
                .privateEndpointConnectionName("{privateEndpointConnectionName}")
                .properties(Map.of("privateLinkServiceConnectionState", Map.ofEntries(
                    Map.entry("description", "Auto-Approved"),
                    Map.entry("status", "Approved")
                )))
                .resourceGroupName("res7687")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    private_endpoint_connection = azure_native.cognitiveservices.PrivateEndpointConnection("privateEndpointConnection",
        account_name="sto9699",
        private_endpoint_connection_name="{privateEndpointConnectionName}",
        properties=azure_native.cognitiveservices.PrivateEndpointConnectionPropertiesResponseArgs(
            private_link_service_connection_state=azure_native.cognitiveservices.PrivateLinkServiceConnectionStateArgs(
                description="Auto-Approved",
                status="Approved",
            ),
        ),
        resource_group_name="res7687")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const privateEndpointConnection = new azure_native.cognitiveservices.PrivateEndpointConnection("privateEndpointConnection", {
        accountName: "sto9699",
        privateEndpointConnectionName: "{privateEndpointConnectionName}",
        properties: {
            privateLinkServiceConnectionState: {
                description: "Auto-Approved",
                status: "Approved",
            },
        },
        resourceGroupName: "res7687",
    });
    
    resources:
      privateEndpointConnection:
        type: azure-native:cognitiveservices:PrivateEndpointConnection
        properties:
          accountName: sto9699
          privateEndpointConnectionName: '{privateEndpointConnectionName}'
          properties:
            privateLinkServiceConnectionState:
              description: Auto-Approved
              status: Approved
          resourceGroupName: res7687
    

    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: PrivateEndpointConnectionInitArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivateEndpointConnection(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  account_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  location: 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:cognitiveservices: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 PrivateEndpointConnectionInitArgs
    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 exampleprivateEndpointConnectionResourceResourceFromCognitiveservices = new AzureNative.Cognitiveservices.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromCognitiveservices", new()
    {
        AccountName = "string",
        ResourceGroupName = "string",
        Location = "string",
        PrivateEndpointConnectionName = "string",
        Properties = 
        {
            { "privateLinkServiceConnectionState", 
            {
                { "actionsRequired", "string" },
                { "description", "string" },
                { "status", "string" },
            } },
            { "groupIds", new[]
            {
                "string",
            } },
        },
    });
    
    example, err := cognitiveservices.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromCognitiveservices", &cognitiveservices.PrivateEndpointConnectionArgs{
    	AccountName:                   "string",
    	ResourceGroupName:             "string",
    	Location:                      "string",
    	PrivateEndpointConnectionName: "string",
    	Properties: map[string]interface{}{
    		"privateLinkServiceConnectionState": map[string]interface{}{
    			"actionsRequired": "string",
    			"description":     "string",
    			"status":          "string",
    		},
    		"groupIds": []string{
    			"string",
    		},
    	},
    })
    
    var exampleprivateEndpointConnectionResourceResourceFromCognitiveservices = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromCognitiveservices", PrivateEndpointConnectionArgs.builder()
        .accountName("string")
        .resourceGroupName("string")
        .location("string")
        .privateEndpointConnectionName("string")
        .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
        .build());
    
    exampleprivate_endpoint_connection_resource_resource_from_cognitiveservices = azure_native.cognitiveservices.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromCognitiveservices",
        account_name=string,
        resource_group_name=string,
        location=string,
        private_endpoint_connection_name=string,
        properties={
            privateLinkServiceConnectionState: {
                actionsRequired: string,
                description: string,
                status: string,
            },
            groupIds: [string],
        })
    
    const exampleprivateEndpointConnectionResourceResourceFromCognitiveservices = new azure_native.cognitiveservices.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromCognitiveservices", {
        accountName: "string",
        resourceGroupName: "string",
        location: "string",
        privateEndpointConnectionName: "string",
        properties: {
            privateLinkServiceConnectionState: {
                actionsRequired: "string",
                description: "string",
                status: "string",
            },
            groupIds: ["string"],
        },
    });
    
    type: azure-native:cognitiveservices:PrivateEndpointConnection
    properties:
        accountName: string
        location: string
        privateEndpointConnectionName: string
        properties:
            groupIds:
                - 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

    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:

    AccountName string
    The name of Cognitive Services account.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Location string
    The location of the private endpoint connection
    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Cognitive Services Account
    Properties Pulumi.AzureNative.CognitiveServices.Inputs.PrivateEndpointConnectionProperties
    Resource properties.
    AccountName string
    The name of Cognitive Services account.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Location string
    The location of the private endpoint connection
    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Cognitive Services Account
    Properties PrivateEndpointConnectionPropertiesArgs
    Resource properties.
    accountName String
    The name of Cognitive Services account.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    location String
    The location of the private endpoint connection
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Cognitive Services Account
    properties PrivateEndpointConnectionProperties
    Resource properties.
    accountName string
    The name of Cognitive Services account.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    location string
    The location of the private endpoint connection
    privateEndpointConnectionName string
    The name of the private endpoint connection associated with the Cognitive Services Account
    properties PrivateEndpointConnectionProperties
    Resource properties.
    account_name str
    The name of Cognitive Services account.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    location str
    The location of the private endpoint connection
    private_endpoint_connection_name str
    The name of the private endpoint connection associated with the Cognitive Services Account
    properties PrivateEndpointConnectionPropertiesArgs
    Resource properties.
    accountName String
    The name of Cognitive Services account.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    location String
    The location of the private endpoint connection
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Cognitive Services Account
    properties Property Map
    Resource properties.

    Outputs

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

    Etag string
    Entity Tag
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    Entity Tag
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Entity Tag
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag string
    Entity Tag
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag str
    Entity Tag
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Entity Tag
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    PrivateEndpointConnectionProperties, PrivateEndpointConnectionPropertiesArgs

    PrivateLinkServiceConnectionState Pulumi.AzureNative.CognitiveServices.Inputs.PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    GroupIds List<string>
    The private link resource group ids.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    GroupIds []string
    The private link resource group ids.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    groupIds List<String>
    The private link resource group ids.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    groupIds string[]
    The private link resource group ids.
    private_link_service_connection_state PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    group_ids Sequence[str]
    The private link resource group ids.
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    groupIds List<String>
    The private link resource group ids.

    PrivateEndpointConnectionPropertiesResponse, PrivateEndpointConnectionPropertiesResponseArgs

    PrivateLinkServiceConnectionState Pulumi.AzureNative.CognitiveServices.Inputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    GroupIds List<string>
    The private link resource group ids.
    PrivateEndpoint Pulumi.AzureNative.CognitiveServices.Inputs.PrivateEndpointResponse
    The resource of private end point.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    GroupIds []string
    The private link resource group ids.
    PrivateEndpoint PrivateEndpointResponse
    The resource of private end point.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    groupIds List<String>
    The private link resource group ids.
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    groupIds string[]
    The private link resource group ids.
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    group_ids Sequence[str]
    The private link resource group ids.
    private_endpoint PrivateEndpointResponse
    The resource of private end point.
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    groupIds List<String>
    The private link resource group ids.
    privateEndpoint Property Map
    The resource of private end point.

    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
    Disconnected
    Disconnected
    PrivateEndpointServiceConnectionStatusPending
    Pending
    PrivateEndpointServiceConnectionStatusApproved
    Approved
    PrivateEndpointServiceConnectionStatusRejected
    Rejected
    PrivateEndpointServiceConnectionStatusDisconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PENDING
    Pending
    APPROVED
    Approved
    REJECTED
    Rejected
    DISCONNECTED
    Disconnected
    "Pending"
    Pending
    "Approved"
    Approved
    "Rejected"
    Rejected
    "Disconnected"
    Disconnected

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    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.CognitiveServices.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" | "Disconnected"
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    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:cognitiveservices:PrivateEndpointConnection {privateEndpointConnectionName} /subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi