1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi

azure-native.automation.getPrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi

    Gets a private endpoint connection. Azure REST API version: 2020-01-13-preview.

    Other available API versions: 2023-05-15-preview.

    Using getPrivateEndpointConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrivateEndpointConnection(args: GetPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionResult>
    function getPrivateEndpointConnectionOutput(args: GetPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointConnectionResult>
    def get_private_endpoint_connection(automation_account_name: Optional[str] = None,
                                        private_endpoint_connection_name: Optional[str] = None,
                                        resource_group_name: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
    def get_private_endpoint_connection_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                                        private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                        resource_group_name: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointConnectionResult]
    func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
    func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput

    > Note: This function is named LookupPrivateEndpointConnection in the Go SDK.

    public static class GetPrivateEndpointConnection 
    {
        public static Task<GetPrivateEndpointConnectionResult> InvokeAsync(GetPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:automation:getPrivateEndpointConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AutomationAccountName string
    The name of the automation account.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    Name of an Azure Resource group.
    AutomationAccountName string
    The name of the automation account.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    Name of an Azure Resource group.
    automationAccountName String
    The name of the automation account.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    Name of an Azure Resource group.
    automationAccountName string
    The name of the automation account.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    resourceGroupName string
    Name of an Azure Resource group.
    automation_account_name str
    The name of the automation account.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    resource_group_name str
    Name of an Azure Resource group.
    automationAccountName String
    The name of the automation account.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    Name of an Azure Resource group.

    getPrivateEndpointConnection Result

    The following output properties are available:

    Id string
    Fully qualified resource Id for the resource
    Name string
    The name of the resource
    Type string
    The type of the resource.
    GroupIds List<string>
    Gets the groupIds.
    PrivateEndpoint Pulumi.AzureNative.Automation.Outputs.PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Automation.Outputs.PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    Id string
    Fully qualified resource Id for the resource
    Name string
    The name of the resource
    Type string
    The type of the resource.
    GroupIds []string
    Gets the groupIds.
    PrivateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    id String
    Fully qualified resource Id for the resource
    name String
    The name of the resource
    type String
    The type of the resource.
    groupIds List<String>
    Gets the groupIds.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    id string
    Fully qualified resource Id for the resource
    name string
    The name of the resource
    type string
    The type of the resource.
    groupIds string[]
    Gets the groupIds.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    id str
    Fully qualified resource Id for the resource
    name str
    The name of the resource
    type str
    The type of the resource.
    group_ids Sequence[str]
    Gets the groupIds.
    private_endpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    id String
    Fully qualified resource Id for the resource
    name String
    The name of the resource
    type String
    The type of the resource.
    groupIds List<String>
    Gets the groupIds.
    privateEndpoint Property Map
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState Property Map
    Connection State of the Private Endpoint Connection.

    Supporting Types

    PrivateEndpointPropertyResponse

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateLinkServiceConnectionStatePropertyResponse

    ActionsRequired string
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    ActionsRequired string
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    actionsRequired String
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    actionsRequired string
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    actions_required str
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    actionsRequired String
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    description String
    The private link service connection description.
    status String
    The private link service connection status.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi