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 34
Operations
- GETOperations_List
/providers/Microsoft.Relay/operations?api-version=stringLists all available Relay REST API operations.
Namespaces
- POSTNamespaces_CheckNameAvailability
/subscriptions/:subscriptionId/providers/Microsoft.Relay/checkNameAvailability?api-version=stringCheck the specified namespace name availability. - GETNamespaces_List
/subscriptions/:subscriptionId/providers/Microsoft.Relay/namespaces?api-version=stringLists all the available namespaces within the subscription regardless of the resourceGroups. - GETNamespaces_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces?api-version=stringLists all the available namespaces within the ResourceGroup. - GETNamespaces_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName?api-version=stringReturns the description for the specified namespace. - PUTNamespaces_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName?api-version=stringCreate Azure Relay namespace. - DELETENamespaces_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName?api-version=stringDeletes an existing namespace. This operation also removes all associated resources under the namespace. - PATCHNamespaces_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName?api-version=stringCreates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. - GETNamespaces_ListAuthorizationRules
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules?api-version=stringAuthorization rules for a namespace. - GETNamespaces_GetAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleName?api-version=stringAuthorization rule for a namespace by name. - PUTNamespaces_CreateOrUpdateAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleName?api-version=stringCreates or updates an authorization rule for a namespace. - DELETENamespaces_DeleteAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleName?api-version=stringDeletes a namespace authorization rule. - POSTNamespaces_ListKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/listKeys?api-version=stringPrimary and secondary connection strings to the namespace. - POSTNamespaces_RegenerateKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/regenerateKeys?api-version=stringRegenerates the primary or secondary connection strings to the namespace.
HybridConnections
- GETHybridConnections_ListByNamespace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections?api-version=stringLists the hybrid connection within the namespace. - GETHybridConnections_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName?api-version=stringReturns the description for the specified hybrid connection. - PUTHybridConnections_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName?api-version=stringCreates or updates a service hybrid connection. This operation is idempotent. - DELETEHybridConnections_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName?api-version=stringDeletes a hybrid connection. - GETHybridConnections_ListAuthorizationRules
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules?api-version=stringAuthorization rules for a hybrid connection. - GETHybridConnections_GetAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleName?api-version=stringHybrid connection authorization rule for a hybrid connection by name. - PUTHybridConnections_CreateOrUpdateAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleName?api-version=stringCreates or updates an authorization rule for a hybrid connection. - DELETEHybridConnections_DeleteAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleName?api-version=stringDeletes a hybrid connection authorization rule. - POSTHybridConnections_ListKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleName/listKeys?api-version=stringPrimary and secondary connection strings to the hybrid connection. - POSTHybridConnections_RegenerateKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/hybridConnections/:hybridConnectionName/authorizationRules/:authorizationRuleName/regenerateKeys?api-version=stringRegenerates the primary or secondary connection strings to the hybrid connection.
WCFRelays
- GETWCFRelays_ListByNamespace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays?api-version=stringLists the WCF relays within the namespace. - GETWCFRelays_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName?api-version=stringReturns the description for the specified WCF relay. - PUTWCFRelays_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName?api-version=stringCreates or updates a WCF relay. This operation is idempotent. - DELETEWCFRelays_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName?api-version=stringDeletes a WCF relay. - GETWCFRelays_ListAuthorizationRules
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules?api-version=stringAuthorization rules for a WCF relay. - GETWCFRelays_GetAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleName?api-version=stringGet authorizationRule for a WCF relay by name. - PUTWCFRelays_CreateOrUpdateAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleName?api-version=stringCreates or updates an authorization rule for a WCF relay. - DELETEWCFRelays_DeleteAuthorizationRule
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleName?api-version=stringDeletes a WCF relay authorization rule. - POSTWCFRelays_ListKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleName/listKeys?api-version=stringPrimary and secondary connection strings to the WCF relay. - POSTWCFRelays_RegenerateKeys
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Relay/namespaces/:namespaceName/wcfRelays/:relayName/authorizationRules/:authorizationRuleName/regenerateKeys?api-version=stringRegenerates the primary or secondary connection strings to the WCF relay.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 34 operations on 21 pathsGET 14POST 7PUT 6DELETE 6PATCH 1
- Main resources
- Namespaces 13HybridConnections 10WCFRelays 10Operations 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2017-04-01 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the 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 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?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Relay?
Use these API to manage Azure Relay resources through Azure Resource Manager. It is listed under Developer tools and has 34 endpoints.
Who publishes the 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 Relay?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Relay?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Relay have?
34 operations on 21 paths (14 GET, 7 POST, 6 PUT, 6 DELETE, 1 PATCH). The largest groups are Namespaces, HybridConnections, WCFRelays, Operations.
Is forking the Relay free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.