Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. relay
  5. getHybridConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.relay.getHybridConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns the description for the specified hybrid connection.

Uses Azure REST API version 2024-01-01.

Other available API versions: 2021-11-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native relay [ApiVersion]. See the version guide for details.

Using getHybridConnection

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 getHybridConnection(args: GetHybridConnectionArgs, opts?: InvokeOptions): Promise<GetHybridConnectionResult>
function getHybridConnectionOutput(args: GetHybridConnectionOutputArgs, opts?: InvokeOptions): Output<GetHybridConnectionResult>
Copy
def get_hybrid_connection(hybrid_connection_name: Optional[str] = None,
                          namespace_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHybridConnectionResult
def get_hybrid_connection_output(hybrid_connection_name: Optional[pulumi.Input[str]] = None,
                          namespace_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHybridConnectionResult]
Copy
func LookupHybridConnection(ctx *Context, args *LookupHybridConnectionArgs, opts ...InvokeOption) (*LookupHybridConnectionResult, error)
func LookupHybridConnectionOutput(ctx *Context, args *LookupHybridConnectionOutputArgs, opts ...InvokeOption) LookupHybridConnectionResultOutput
Copy

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

public static class GetHybridConnection 
{
    public static Task<GetHybridConnectionResult> InvokeAsync(GetHybridConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetHybridConnectionResult> Invoke(GetHybridConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHybridConnectionResult> getHybridConnection(GetHybridConnectionArgs args, InvokeOptions options)
public static Output<GetHybridConnectionResult> getHybridConnection(GetHybridConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:relay:getHybridConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HybridConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The hybrid connection name.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
HybridConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The hybrid connection name.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
hybridConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The hybrid connection name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
hybridConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The hybrid connection name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
hybrid_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The hybrid connection name.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The namespace name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Resource group within the Azure subscription.
hybridConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The hybrid connection name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.

getHybridConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CreatedAt string
The time the hybrid connection was created.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ListenerCount int
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData Pulumi.AzureNative.Relay.Outputs.SystemDataResponse
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"
UpdatedAt string
The time the namespace was updated.
RequiresClientAuthorization bool
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
UserMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
AzureApiVersion string
The Azure API version of the resource.
CreatedAt string
The time the hybrid connection was created.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ListenerCount int
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData SystemDataResponse
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"
UpdatedAt string
The time the namespace was updated.
RequiresClientAuthorization bool
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
UserMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
azureApiVersion String
The Azure API version of the resource.
createdAt String
The time the hybrid connection was created.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
listenerCount Integer
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location String
The geo-location where the resource lives
name String
The name of the resource
systemData SystemDataResponse
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"
updatedAt String
The time the namespace was updated.
requiresClientAuthorization Boolean
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
userMetadata String
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
azureApiVersion string
The Azure API version of the resource.
createdAt string
The time the hybrid connection was created.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
listenerCount number
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location string
The geo-location where the resource lives
name string
The name of the resource
systemData SystemDataResponse
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"
updatedAt string
The time the namespace was updated.
requiresClientAuthorization boolean
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
userMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
azure_api_version str
The Azure API version of the resource.
created_at str
The time the hybrid connection was created.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
listener_count int
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location str
The geo-location where the resource lives
name str
The name of the resource
system_data SystemDataResponse
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"
updated_at str
The time the namespace was updated.
requires_client_authorization bool
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
user_metadata str
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
azureApiVersion String
The Azure API version of the resource.
createdAt String
The time the hybrid connection was created.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
listenerCount Number
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location String
The geo-location where the resource lives
name String
The name of the resource
systemData 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"
updatedAt String
The time the namespace was updated.
requiresClientAuthorization Boolean
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
userMetadata String
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.

Supporting Types

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
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native