azure-native.servicebus.getPrivateEndpointConnection
Explore with Pulumi AI
Gets a description for the specified Private Endpoint Connection.
Uses Azure REST API version 2024-01-01.
Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native servicebus [ApiVersion]
. See the version guide for details.
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(namespace_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(namespace_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)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:servicebus:getPrivateEndpointConnection
arguments:
# arguments dictionary
The following arguments are supported:
- Namespace
Name string - The namespace name
- Private
Endpoint stringConnection Name - The PrivateEndpointConnection name
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Namespace
Name string - The namespace name
- Private
Endpoint stringConnection Name - The PrivateEndpointConnection name
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- namespace
Name String - The namespace name
- private
Endpoint StringConnection Name - The PrivateEndpointConnection name
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- namespace
Name string - The namespace name
- private
Endpoint stringConnection Name - The PrivateEndpointConnection name
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- namespace_
name str - The namespace name
- private_
endpoint_ strconnection_ name - The PrivateEndpointConnection name
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- namespace
Name String - The namespace name
- private
Endpoint StringConnection Name - The PrivateEndpointConnection name
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getPrivateEndpointConnection Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Service Bus. Outputs. System Data Response - The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- Private
Endpoint Pulumi.Azure Native. Service Bus. Outputs. Private Endpoint Response - The Private Endpoint resource for this Connection.
- Private
Link Pulumi.Service Connection State Azure Native. Service Bus. Outputs. Connection State Response - Details about the state of the connection.
- Provisioning
State string - Provisioning state of the Private Endpoint Connection.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data SystemData Response - The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- Private
Endpoint PrivateEndpoint Response - The Private Endpoint resource for this Connection.
- Private
Link ConnectionService Connection State State Response - Details about the state of the connection.
- Provisioning
State string - Provisioning state of the Private Endpoint Connection.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data SystemData Response - The system meta data relating to this resource.
- type String
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- private
Endpoint PrivateEndpoint Response - The Private Endpoint resource for this Connection.
- private
Link ConnectionService Connection State State Response - Details about the state of the connection.
- provisioning
State String - Provisioning state of the Private Endpoint Connection.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- system
Data SystemData Response - The system meta data relating to this resource.
- type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- private
Endpoint PrivateEndpoint Response - The Private Endpoint resource for this Connection.
- private
Link ConnectionService Connection State State Response - Details about the state of the connection.
- provisioning
State string - Provisioning state of the Private Endpoint Connection.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- system_
data SystemData Response - The system meta data relating to this resource.
- type str
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- private_
endpoint PrivateEndpoint Response - The Private Endpoint resource for this Connection.
- private_
link_ Connectionservice_ connection_ state State Response - Details about the state of the connection.
- provisioning_
state str - Provisioning state of the Private Endpoint Connection.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data Property Map - The system meta data relating to this resource.
- type String
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- private
Endpoint Property Map - The Private Endpoint resource for this Connection.
- private
Link Property MapService Connection State - Details about the state of the connection.
- provisioning
State String - Provisioning state of the Private Endpoint Connection.
Supporting Types
ConnectionStateResponse
- Description string
- Description of the connection state.
- Status string
- Status of the connection.
- Description string
- Description of the connection state.
- Status string
- Status of the connection.
- description String
- Description of the connection state.
- status String
- Status of the connection.
- description string
- Description of the connection state.
- status string
- Status of the connection.
- description str
- Description of the connection state.
- status str
- Status of the connection.
- description String
- Description of the connection state.
- status String
- Status of the connection.
PrivateEndpointResponse
- 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.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The type of identity that last modified the resource.
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The type of identity that last modified the resource.
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0