1. Packages
  2. Azure Native
  3. API Docs
  4. relay
  5. listHybridConnectionKeys
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.relay.listHybridConnectionKeys

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Primary and secondary connection strings to the 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 listHybridConnectionKeys

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 listHybridConnectionKeys(args: ListHybridConnectionKeysArgs, opts?: InvokeOptions): Promise<ListHybridConnectionKeysResult>
function listHybridConnectionKeysOutput(args: ListHybridConnectionKeysOutputArgs, opts?: InvokeOptions): Output<ListHybridConnectionKeysResult>
Copy
def list_hybrid_connection_keys(authorization_rule_name: Optional[str] = None,
                                hybrid_connection_name: Optional[str] = None,
                                namespace_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> ListHybridConnectionKeysResult
def list_hybrid_connection_keys_output(authorization_rule_name: Optional[pulumi.Input[str]] = None,
                                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[ListHybridConnectionKeysResult]
Copy
func ListHybridConnectionKeys(ctx *Context, args *ListHybridConnectionKeysArgs, opts ...InvokeOption) (*ListHybridConnectionKeysResult, error)
func ListHybridConnectionKeysOutput(ctx *Context, args *ListHybridConnectionKeysOutputArgs, opts ...InvokeOption) ListHybridConnectionKeysResultOutput
Copy

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

public static class ListHybridConnectionKeys 
{
    public static Task<ListHybridConnectionKeysResult> InvokeAsync(ListHybridConnectionKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListHybridConnectionKeysResult> Invoke(ListHybridConnectionKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListHybridConnectionKeysResult> listHybridConnectionKeys(ListHybridConnectionKeysArgs args, InvokeOptions options)
public static Output<ListHybridConnectionKeysResult> listHybridConnectionKeys(ListHybridConnectionKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:relay:listHybridConnectionKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AuthorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
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.
AuthorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
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.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
String
The authorization rule name.
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.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
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.
authorization_rule_name
This property is required.
Changes to this property will trigger replacement.
str
The authorization rule name.
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.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
String
The authorization rule name.
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.

listHybridConnectionKeys Result

The following output properties are available:

KeyName string
A string that describes the authorization rule.
PrimaryConnectionString string
Primary connection string of the created namespace authorization rule.
PrimaryKey string
A base64-encoded 256-bit primary key for signing and validating the SAS token.
SecondaryConnectionString string
Secondary connection string of the created namespace authorization rule.
SecondaryKey string
A base64-encoded 256-bit secondary key for signing and validating the SAS token.
KeyName string
A string that describes the authorization rule.
PrimaryConnectionString string
Primary connection string of the created namespace authorization rule.
PrimaryKey string
A base64-encoded 256-bit primary key for signing and validating the SAS token.
SecondaryConnectionString string
Secondary connection string of the created namespace authorization rule.
SecondaryKey string
A base64-encoded 256-bit secondary key for signing and validating the SAS token.
keyName String
A string that describes the authorization rule.
primaryConnectionString String
Primary connection string of the created namespace authorization rule.
primaryKey String
A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondaryConnectionString String
Secondary connection string of the created namespace authorization rule.
secondaryKey String
A base64-encoded 256-bit secondary key for signing and validating the SAS token.
keyName string
A string that describes the authorization rule.
primaryConnectionString string
Primary connection string of the created namespace authorization rule.
primaryKey string
A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondaryConnectionString string
Secondary connection string of the created namespace authorization rule.
secondaryKey string
A base64-encoded 256-bit secondary key for signing and validating the SAS token.
key_name str
A string that describes the authorization rule.
primary_connection_string str
Primary connection string of the created namespace authorization rule.
primary_key str
A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondary_connection_string str
Secondary connection string of the created namespace authorization rule.
secondary_key str
A base64-encoded 256-bit secondary key for signing and validating the SAS token.
keyName String
A string that describes the authorization rule.
primaryConnectionString String
Primary connection string of the created namespace authorization rule.
primaryKey String
A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondaryConnectionString String
Secondary connection string of the created namespace authorization rule.
secondaryKey String
A base64-encoded 256-bit secondary key for signing and validating the SAS token.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi