Hybrid Connections - List Keys

  • Reference
Service:
Relay
API Version:
2024-01-01

Primary and secondary connection strings to the hybrid connection.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2024-01-01

URI Parameters

Name In Required Type Description
authorizationRuleName
 path True

string

The authorization rule name.
hybridConnectionName
 path True

string

The hybrid connection name.
namespaceName
 path True

string

The namespace name
resourceGroupName
 path True

string

Name of the Resource group within the Azure subscription.
subscriptionId
 path True

string

Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True

string

Client API version.

Responses

Name Type Description
200 OK

AccessKeys

Request to retrieve connection strings to the hybrid connection succeeded.
Other Status Codes

ErrorResponse

Relay error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

RelayHybridConnectionAuthorizationRuleListKey

Sample request

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/hybridConnections/example-Relay-Hybrid-01/authorizationRules/example-RelayAuthRules-01/listKeys?api-version=2024-01-01

Sample response

Status code:
200 
{
  "primaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "example-RelayAuthRules-01"
}

Definitions

Name Description
AccessKeys

Namespace/Relay Connection String
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

AccessKeys

Namespace/Relay Connection String

Name Type Description
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.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.