Microsoft.Relay (stable:2017-04-01)

2025/09/12 • 34 new, 34 deleted methods

Operations_List (new)
Description :  Lists all available Relay REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Relay/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Relay operations supported by resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Relay. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CheckNameAvailability (new)
Description :  Check the specified namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to check availability of the specified namespace name. ,
Required: True ,
}
{
name:
{
Description: The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Value indicating namespace is available. Returns true if the namespace is available; otherwise, false. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability of a namespace. ,
Enum:
{
None: No description available. ,
InvalidName: No description available. ,
SubscriptionIsDisabled: No description available. ,
NameInUse: No description available. ,
NameInLockdown: No description available. ,
TooManyNamespaceInCurrentSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_List (new)
Description :  Lists all the available namespaces within the subscription regardless of the resourceGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListByResourceGroup (new)
Description :  Lists all the available namespaces within the ResourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdate (new)
Description :  Create Azure Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Delete (new)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Get (new)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Update (new)
Description :  Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListAuthorizationRules (new)
Description :  Authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list authorization rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of authorization rules. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an authorization rule for a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_DeleteAuthorizationRule (new)
Description :  Deletes a namespace authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetAuthorizationRule (new)
Description :  Authorization rule for a namespace by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListKeys (new)
Description :  Primary and secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_ListByNamespace (new)
Description :  Lists the hybrid connection within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list hybrid connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list hybrid connection operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_CreateOrUpdate (new)
Description :  Creates or updates a service hybrid connection. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a hybrid connection. ,
Required: True ,
}
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_Delete (new)
Description :  Deletes a hybrid connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_Get (new)
Description :  Returns the description for the specified hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_ListAuthorizationRules (new)
Description :  Authorization rules for a hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list authorization rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of authorization rules. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an authorization rule for a hybrid connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_DeleteAuthorizationRule (new)
Description :  Deletes a hybrid connection authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_GetAuthorizationRule (new)
Description :  Hybrid connection authorization rule for a hybrid connection by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_ListKeys (new)
Description :  Primary and secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_ListByNamespace (new)
Description :  Lists the WCF relays within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list WCF relay operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of WCF relays. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_CreateOrUpdate (new)
Description :  Creates or updates a WCF relay. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a WCF relay. ,
Required: True ,
}
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_Delete (new)
Description :  Deletes a WCF relay.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_Get (new)
Description :  Returns the description for the specified WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_ListAuthorizationRules (new)
Description :  Authorization rules for a WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list authorization rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of authorization rules. ,
Required: False ,
}
string ,
}
WCFRelays_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an authorization rule for a WCF relay.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_DeleteAuthorizationRule (new)
Description :  Deletes a WCF relay authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_GetAuthorizationRule (new)
Description :  Get authorizationRule for a WCF relay by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_ListKeys (new)
Description :  Primary and secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists all available Relay REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Relay/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Relay operations supported by resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Relay. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CheckNameAvailability (removed)
Description :  Check the specified namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to check availability of the specified namespace name. ,
Required: True ,
}
{
name:
{
Description: The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Value indicating namespace is available. Returns true if the namespace is available; otherwise, false. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability of a namespace. ,
Enum:
{
None: No description available. ,
InvalidName: No description available. ,
SubscriptionIsDisabled: No description available. ,
NameInUse: No description available. ,
NameInLockdown: No description available. ,
TooManyNamespaceInCurrentSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_List (removed)
Description :  Lists all the available namespaces within the subscription regardless of the resourceGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListByResourceGroup (removed)
Description :  Lists all the available namespaces within the ResourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list namespace operation. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdate (removed)
Description :  Create Azure Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Delete (removed)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Get (removed)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Update (removed)
Description :  Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListAuthorizationRules (removed)
Description :  Authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list authorization rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of authorization rules. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an authorization rule for a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_DeleteAuthorizationRule (removed)
Description :  Deletes a namespace authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetAuthorizationRule (removed)
Description :  Authorization rule for a namespace by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListKeys (removed)
Description :  Primary and secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_ListByNamespace (removed)
Description :  Lists the hybrid connection within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list hybrid connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list hybrid connection operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_CreateOrUpdate (removed)
Description :  Creates or updates a service hybrid connection. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a hybrid connection. ,
Required: True ,
}
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_Delete (removed)
Description :  Deletes a hybrid connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_Get (removed)
Description :  Returns the description for the specified hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_ListAuthorizationRules (removed)
Description :  Authorization rules for a hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list authorization rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of authorization rules. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an authorization rule for a hybrid connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_DeleteAuthorizationRule (removed)
Description :  Deletes a hybrid connection authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_GetAuthorizationRule (removed)
Description :  Hybrid connection authorization rule for a hybrid connection by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_ListKeys (removed)
Description :  Primary and secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridConnections_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_ListByNamespace (removed)
Description :  Lists the WCF relays within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list WCF relay operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of WCF relays. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_CreateOrUpdate (removed)
Description :  Creates or updates a WCF relay. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a WCF relay. ,
Required: True ,
}
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_Delete (removed)
Description :  Deletes a WCF relay.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_Get (removed)
Description :  Returns the description for the specified WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_ListAuthorizationRules (removed)
Description :  Authorization rules for a WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list authorization rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of authorization rules. ,
Required: False ,
}
string ,
}
WCFRelays_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an authorization rule for a WCF relay.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_DeleteAuthorizationRule (removed)
Description :  Deletes a WCF relay authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_GetAuthorizationRule (removed)
Description :  Get authorizationRule for a WCF relay by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Authorization rule properties. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_ListKeys (removed)
Description :  Primary and secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
WCFRelays_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}