azure-native.search.PrivateEndpointConnection
Explore with Pulumi AI
Describes an existing Private Endpoint connection to the Azure Cognitive Search service. API Version: 2020-08-01.
Example Usage
PrivateEndpointConnectionUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpointConnection = new AzureNative.Search.PrivateEndpointConnection("privateEndpointConnection", new()
{
PrivateEndpointConnectionName = "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
Properties = new AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesArgs
{
PrivateLinkServiceConnectionState = new AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateArgs
{
Description = "Rejected for some reason",
Status = AzureNative.Search.PrivateLinkServiceConnectionStatus.Rejected,
},
},
ResourceGroupName = "rg1",
SearchServiceName = "mysearchservice",
});
});
package main
import (
search "github.com/pulumi/pulumi-azure-native-sdk/search"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := search.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &search.PrivateEndpointConnectionArgs{
PrivateEndpointConnectionName: pulumi.String("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
Properties: search.PrivateEndpointConnectionPropertiesResponse{
PrivateLinkServiceConnectionState: &search.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateArgs{
Description: pulumi.String("Rejected for some reason"),
Status: search.PrivateLinkServiceConnectionStatusRejected,
},
},
ResourceGroupName: pulumi.String("rg1"),
SearchServiceName: pulumi.String("mysearchservice"),
})
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.search.PrivateEndpointConnection;
import com.pulumi.azurenative.search.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()
.privateEndpointConnectionName("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546")
.properties(Map.of("privateLinkServiceConnectionState", Map.ofEntries(
Map.entry("description", "Rejected for some reason"),
Map.entry("status", "Rejected")
)))
.resourceGroupName("rg1")
.searchServiceName("mysearchservice")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
private_endpoint_connection = azure_native.search.PrivateEndpointConnection("privateEndpointConnection",
private_endpoint_connection_name="testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
properties=azure_native.search.PrivateEndpointConnectionPropertiesResponseArgs(
private_link_service_connection_state=azure_native.search.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateArgs(
description="Rejected for some reason",
status=azure_native.search.PrivateLinkServiceConnectionStatus.REJECTED,
),
),
resource_group_name="rg1",
search_service_name="mysearchservice")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const privateEndpointConnection = new azure_native.search.PrivateEndpointConnection("privateEndpointConnection", {
privateEndpointConnectionName: "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
properties: {
privateLinkServiceConnectionState: {
description: "Rejected for some reason",
status: azure_native.search.PrivateLinkServiceConnectionStatus.Rejected,
},
},
resourceGroupName: "rg1",
searchServiceName: "mysearchservice",
});
resources:
privateEndpointConnection:
type: azure-native:search:PrivateEndpointConnection
properties:
privateEndpointConnectionName: testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546
properties:
privateLinkServiceConnectionState:
description: Rejected for some reason
status: Rejected
resourceGroupName: rg1
searchServiceName: mysearchservice
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,
search_service_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:search: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 exampleprivateEndpointConnectionResourceResourceFromSearch = new AzureNative.Search.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSearch", new()
{
ResourceGroupName = "string",
SearchServiceName = "string",
PrivateEndpointConnectionName = "string",
Properties =
{
{ "privateEndpoint",
{
{ "id", "string" },
} },
{ "privateLinkServiceConnectionState",
{
{ "actionsRequired", "string" },
{ "description", "string" },
{ "status", "Pending" },
} },
},
});
example, err := search.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromSearch", &search.PrivateEndpointConnectionArgs{
ResourceGroupName: "string",
SearchServiceName: "string",
PrivateEndpointConnectionName: "string",
Properties: map[string]interface{}{
"privateEndpoint": map[string]interface{}{
"id": "string",
},
"privateLinkServiceConnectionState": map[string]interface{}{
"actionsRequired": "string",
"description": "string",
"status": "Pending",
},
},
})
var exampleprivateEndpointConnectionResourceResourceFromSearch = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSearch", PrivateEndpointConnectionArgs.builder()
.resourceGroupName("string")
.searchServiceName("string")
.privateEndpointConnectionName("string")
.properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
exampleprivate_endpoint_connection_resource_resource_from_search = azure_native.search.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSearch",
resource_group_name=string,
search_service_name=string,
private_endpoint_connection_name=string,
properties={
privateEndpoint: {
id: string,
},
privateLinkServiceConnectionState: {
actionsRequired: string,
description: string,
status: Pending,
},
})
const exampleprivateEndpointConnectionResourceResourceFromSearch = new azure_native.search.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSearch", {
resourceGroupName: "string",
searchServiceName: "string",
privateEndpointConnectionName: "string",
properties: {
privateEndpoint: {
id: "string",
},
privateLinkServiceConnectionState: {
actionsRequired: "string",
description: "string",
status: "Pending",
},
},
});
type: azure-native:search:PrivateEndpointConnection
properties:
privateEndpointConnectionName: string
properties:
privateEndpoint:
id: string
privateLinkServiceConnectionState:
actionsRequired: string
description: string
status: Pending
resourceGroupName: string
searchServiceName: 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 within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- Search
Service stringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- Properties
Pulumi.
Azure Native. Search. Inputs. Private Endpoint Connection Properties - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
- Resource
Group stringName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- Search
Service stringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- Properties
Private
Endpoint Connection Properties Args - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
- resource
Group StringName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search
Service StringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- private
Endpoint StringConnection Name - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- properties
Private
Endpoint Connection Properties - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
- resource
Group stringName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search
Service stringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- private
Endpoint stringConnection Name - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- properties
Private
Endpoint Connection Properties - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
- resource_
group_ strname - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search_
service_ strname - The name of the Azure Cognitive Search service associated with the specified resource group.
- private_
endpoint_ strconnection_ name - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- properties
Private
Endpoint Connection Properties Args - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
- resource
Group StringName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search
Service StringName - The name of the Azure Cognitive Search service associated with the specified resource group.
- private
Endpoint StringConnection Name - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- properties Property Map
- Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnection resource produces the following output properties:
Supporting Types
PrivateEndpointConnectionProperties, PrivateEndpointConnectionPropertiesArgs
- Private
Endpoint Pulumi.Azure Native. Search. Inputs. Private Endpoint Connection Properties Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- Private
Link Pulumi.Service Connection State Azure Native. Search. Inputs. Private Endpoint Connection Properties Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- Private
Endpoint PrivateEndpoint Connection Properties Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- Private
Link PrivateService Connection State Endpoint Connection Properties Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private
Endpoint PrivateEndpoint Connection Properties Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- private
Link PrivateService Connection State Endpoint Connection Properties Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private
Endpoint PrivateEndpoint Connection Properties Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- private
Link PrivateService Connection State Endpoint Connection Properties Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private_
endpoint PrivateEndpoint Connection Properties Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- private_
link_ Privateservice_ connection_ state Endpoint Connection Properties Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private
Endpoint Property Map - The private endpoint resource from Microsoft.Network provider.
- private
Link Property MapService Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
PrivateEndpointConnectionPropertiesPrivateEndpoint, PrivateEndpointConnectionPropertiesPrivateEndpointArgs
- Id string
- The resource id of the private endpoint resource from Microsoft.Network provider.
- Id string
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id String
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id string
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id str
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id String
- The resource id of the private endpoint resource from Microsoft.Network provider.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState, PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateArgs
- Actions
Required string - A description of any extra actions that may be required.
- Description string
- The description for the private link service connection state.
- Status
Pulumi.
Azure Native. Search. Private Link Service Connection Status - Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- Actions
Required string - A description of any extra actions that may be required.
- Description string
- The description for the private link service connection state.
- Status
Private
Link Service Connection Status - Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions
Required String - A description of any extra actions that may be required.
- description String
- The description for the private link service connection state.
- status
Private
Link Service Connection Status - Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions
Required string - A description of any extra actions that may be required.
- description string
- The description for the private link service connection state.
- status
Private
Link Service Connection Status - Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions_
required str - A description of any extra actions that may be required.
- description str
- The description for the private link service connection state.
- status
Private
Link Service Connection Status - Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions
Required String - A description of any extra actions that may be required.
- description String
- The description for the private link service connection state.
- status "Pending" | "Approved" | "Rejected" | "Disconnected"
- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
PrivateEndpointConnectionPropertiesResponse, PrivateEndpointConnectionPropertiesResponseArgs
- Private
Endpoint Pulumi.Azure Native. Search. Inputs. Private Endpoint Connection Properties Response Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- Private
Link Pulumi.Service Connection State Azure Native. Search. Inputs. Private Endpoint Connection Properties Response Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- Private
Endpoint PrivateEndpoint Connection Properties Response Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- Private
Link PrivateService Connection State Endpoint Connection Properties Response Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private
Endpoint PrivateEndpoint Connection Properties Response Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- private
Link PrivateService Connection State Endpoint Connection Properties Response Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private
Endpoint PrivateEndpoint Connection Properties Response Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- private
Link PrivateService Connection State Endpoint Connection Properties Response Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private_
endpoint PrivateEndpoint Connection Properties Response Private Endpoint - The private endpoint resource from Microsoft.Network provider.
- private_
link_ Privateservice_ connection_ state Endpoint Connection Properties Response Private Link Service Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
- private
Endpoint Property Map - The private endpoint resource from Microsoft.Network provider.
- private
Link Property MapService Connection State - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
PrivateEndpointConnectionPropertiesResponsePrivateEndpoint, PrivateEndpointConnectionPropertiesResponsePrivateEndpointArgs
- Id string
- The resource id of the private endpoint resource from Microsoft.Network provider.
- Id string
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id String
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id string
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id str
- The resource id of the private endpoint resource from Microsoft.Network provider.
- id String
- The resource id of the private endpoint resource from Microsoft.Network provider.
PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState, PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionStateArgs
- Actions
Required string - A description of any extra actions that may be required.
- Description string
- The description for the private link service connection state.
- Status string
- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- Actions
Required string - A description of any extra actions that may be required.
- Description string
- The description for the private link service connection state.
- Status string
- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions
Required String - A description of any extra actions that may be required.
- description String
- The description for the private link service connection state.
- status String
- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions
Required string - A description of any extra actions that may be required.
- description string
- The description for the private link service connection state.
- status string
- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions_
required str - A description of any extra actions that may be required.
- description str
- The description for the private link service connection state.
- status str
- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
- actions
Required String - A description of any extra actions that may be required.
- description String
- The description for the private link service connection state.
- status String
- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
PrivateLinkServiceConnectionStatus, PrivateLinkServiceConnectionStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Disconnected
- Disconnected
- Private
Link Service Connection Status Pending - Pending
- Private
Link Service Connection Status Approved - Approved
- Private
Link Service Connection Status Rejected - Rejected
- Private
Link Service Connection Status 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
- "Pending"
- Pending
- "Approved"
- Approved
- "Rejected"
- Rejected
- "Disconnected"
- Disconnected
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:search:PrivateEndpointConnection testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546
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