WCF Relays - List Keys

Primary and secondary connection strings to the WCF relay.

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

URI Parameters

Name In Required Type Description
authorizationRuleName
path True
  • string

The authorization rule name.

namespaceName
path True
  • string

The namespace name

relayName
path True
  • string

The relay 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

Successful.

Other Status Codes

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

RelayAuthorizationRuleListKey.json

Sample Request

POST https://management.azure.com/subscriptions/8c246e6a-cbc6-4a87-aff1-d6a886f376ef/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/sdk-RelayNamespace-01/wcfRelays/sdk-Relay-wcf-01/authorizationRules/sdk-RelayAuthRules-01/listKeys?api-version=2017-04-01

Sample Response

{
  "primaryConnectionString": "Endpoint=sb://sdk-relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=sdk-RelayAuthRules-01;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://sdk-relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=sdk-RelayAuthRules-01;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-RelayAuthRules-01"
}

Definitions

AccessKeys

Namespace/Relay Connection String

ErrorResponse

Error reponse indicates Relay service is not able to process the incoming request. The reason is provided in the error message.

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.

ErrorResponse

Error reponse indicates Relay service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.