Azure Relay
Use these API to manage Azure Relay resources through Azure Resource Manager.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Use these API to manage Azure Relay resources through Azure Resource Manager.
Endpoints 42
Operations
- GETOperations_List
/providers/Microsoft.Relay/operationsList the operations for the provider
AuthorizationRules
- GETNamespaces_ListAuthorizationRules
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRulesAuthorization rules for a namespace. - GETNamespaces_GetAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleNameAuthorization rule for a namespace by name. - PUTNamespaces_CreateOrUpdateAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleNameCreates or updates an authorization rule for a namespace. - DELETENamespaces_DeleteAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleNameDeletes a namespace authorization rule. - POSTNamespaces_ListKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/listKeysPrimary and secondary connection strings to the namespace. - POSTNamespaces_RegenerateKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/regenerateKeysRegenerates the primary or secondary connection strings to the namespace.
HybridConnections
- GETHybridConnections_ListAuthorizationRules
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRulesAuthorization rules for a hybrid connection. - GETHybridConnections_GetAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleNameHybrid connection authorization rule for a hybrid connection by name. - PUTHybridConnections_CreateOrUpdateAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleNameCreates or updates an authorization rule for a hybrid connection. - DELETEHybridConnections_DeleteAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleNameDeletes a hybrid connection authorization rule. - POSTHybridConnections_ListKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleName/listKeysPrimary and secondary connection strings to the hybrid connection. - POSTHybridConnections_RegenerateKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleName/regenerateKeysRegenerates the primary or secondary connection strings to the hybrid connection.
WCFRelays
- GETWCFRelays_ListAuthorizationRules
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRulesAuthorization rules for a WCF relay. - GETWCFRelays_GetAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleNameGet authorizationRule for a WCF relay by name. - PUTWCFRelays_CreateOrUpdateAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleNameCreates or updates an authorization rule for a WCF relay. - DELETEWCFRelays_DeleteAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleNameDeletes a WCF relay authorization rule. - POSTWCFRelays_ListKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleName/listKeysPrimary and secondary connection strings to the WCF relay. - POSTWCFRelays_RegenerateKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleName/regenerateKeysRegenerates the primary or secondary connection strings to the WCF relay.
RelayNamespaces
- GETNamespaces_List
/subscriptions/:subscriptionId/providers/Microsoft.Relay/namespacesLists all the available namespaces within the subscription regardless of the resourceGroups. - GETNamespaces_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespacesLists all the available namespaces within the ResourceGroup. - GETNamespaces_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceNameReturns the description for the specified namespace. - PUTNamespaces_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceNameCreate Azure Relay namespace. - DELETENamespaces_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceNameDeletes an existing namespace. This operation also removes all associated resources under the namespace. - PATCHNamespaces_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceNameCreates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
NetworkRuleSets
- GETNamespaces_GetNetworkRuleSet
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/networkRuleSets/defaultGets NetworkRuleSet for a Namespace. - PUTNamespaces_CreateOrUpdateNetworkRuleSet
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/networkRuleSets/defaultCreate or update NetworkRuleSet for a Namespace.
HybridConnectionOperationGroup
- GETHybridConnections_ListByNamespace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnectionsLists the hybrid connection within the namespace. - GETHybridConnections_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionNameReturns the description for the specified hybrid connection. - PUTHybridConnections_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionNameCreates or updates a service hybrid connection. This operation is idempotent. - DELETEHybridConnections_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionNameDeletes a hybrid connection.
WcfRelaysOps
- GETWCFRelays_ListByNamespace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelaysLists the WCF relays within the namespace. - GETWCFRelays_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayNameReturns the description for the specified WCF relay. - PUTWCFRelays_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayNameCreates or updates a WCF relay. This operation is idempotent. - DELETEWCFRelays_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayNameDeletes a WCF relay.
PrivateEndpointConnections
- GETPrivateEndpointConnections_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/privateEndpointConnectionsGets the available PrivateEndpointConnections within a namespace. - GETPrivateEndpointConnections_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionNameGets a description for the specified Private Endpoint Connection name. - PUTPrivateEndpointConnections_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionNameCreates or updates PrivateEndpointConnections of service namespace. - DELETEPrivateEndpointConnections_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionNameDeletes an existing namespace. This operation also removes all associated resources under the namespace.
PrivateLinkResources
- GETPrivateLinkResources_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/privateLinkResourcesLists the private link resources for a container registry. - GETPrivateLinkResources_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/privateLinkResources/:privateLinkResourceNameGets a private link resource by a specified group name for a container registry.
- POSTNamespaces_CheckNameAvailability
/subscriptions/:subscriptionId/providers/Microsoft.Relay/checkNameAvailabilityCheck the specified namespace name availability.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 42 operations on 26 pathsGET 19PUT 8POST 7DELETE 7PATCH 1
- Main resources
- AuthorizationRules 6HybridConnections 6RelayNamespaces 6WCFRelays 6HybridConnectionOperationGroup 4PrivateEndpointConnections 4WcfRelaysOps 4NetworkRuleSets 2PrivateLinkResources 2Operations 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2026-01-01 - Links
- OpenAPI document
How to test the Azure Relay in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Relay collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Relay/operations), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Relay?
Use these API to manage Azure Relay resources through Azure Resource Manager. It is listed under Developer tools and has 42 endpoints.
Who publishes the Azure Relay?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Relay?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Relay?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Relay have?
42 operations on 26 paths (19 GET, 8 PUT, 7 POST, 7 DELETE, 1 PATCH). The largest groups are AuthorizationRules, HybridConnections, RelayNamespaces, WCFRelays.
Is forking the Azure Relay free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.