1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.kusto.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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Gets a private endpoint connection. Azure REST API version: 2022-12-29.

    Other available API versions: 2023-05-02, 2023-08-15, 2024-04-13.

    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(cluster_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(cluster_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:kusto:getPrivateEndpointConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the Kusto cluster.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    ClusterName string
    The name of the Kusto cluster.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    clusterName String
    The name of the Kusto cluster.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    clusterName string
    The name of the Kusto cluster.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    resourceGroupName string
    The name of the resource group containing the Kusto cluster.
    cluster_name str
    The name of the Kusto cluster.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    resource_group_name str
    The name of the resource group containing the Kusto cluster.
    clusterName String
    The name of the Kusto cluster.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.

    getPrivateEndpointConnection Result

    The following output properties are available:

    GroupId string
    Group id of the private endpoint.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    PrivateEndpoint Pulumi.AzureNative.Kusto.Outputs.PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Kusto.Outputs.PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    ProvisioningState string
    Provisioning state of the private endpoint.
    SystemData Pulumi.AzureNative.Kusto.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    GroupId string
    Group id of the private endpoint.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    PrivateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    ProvisioningState string
    Provisioning state of the private endpoint.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupId String
    Group id of the private endpoint.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    provisioningState String
    Provisioning state of the private endpoint.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupId string
    Group id of the private endpoint.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    provisioningState string
    Provisioning state of the private endpoint.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    group_id str
    Group id of the private endpoint.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    private_endpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
    Connection State of the Private Endpoint Connection.
    provisioning_state str
    Provisioning state of the private endpoint.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupId String
    Group id of the private endpoint.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    privateEndpoint Property Map
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState Property Map
    Connection State of the Private Endpoint Connection.
    provisioningState String
    Provisioning state of the private endpoint.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    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.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi