{ "swagger": "2.0", "info": { "title": "Relay API", "description": "Use these API to manage Azure Relay resources through Azure Resource Manager.", "version": "2017-04-01", "x-ms-code-generation-settings": { "name": "RelayManagementClient" } }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/providers/Microsoft.Relay/operations": { "get": { "tags": [ "Operations" ], "operationId": "Operations_List", "x-ms-examples": { "RelayOperationsList": { "$ref": "./examples/RelayOperations_List.json" } }, "description": "Lists all available Relay REST API operations.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability": { "post": { "tags": [ "Namespaces" ], "operationId": "Namespaces_CheckNameAvailability", "x-ms-examples": { "RelayCheckNameAvailability": { "$ref": "./examples/NameSpaces/RelayNameSpaceCheckNameAvailability.json" } }, "description": "Check the specified namespace name availability.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailability" }, "description": "Parameters to check availability of the specified namespace name." } ], "responses": { "200": { "description": "Check availability returned successfully.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces": { "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_List", "x-ms-examples": { "RelayNameSpaceListBySubscription": { "$ref": "./examples/NameSpaces/RelayNameSpaceListBySubscription.json" } }, "description": "Lists all the available namespaces within the subscription regardless of the resourceGroups.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespaces returned successfully", "schema": { "$ref": "#/definitions/RelayNamespaceListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces": { "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_ListByResourceGroup", "x-ms-examples": { "RelayNameSpaceListByResourceGroup": { "$ref": "./examples/NameSpaces/RelayNameSpaceListByResourceGroup.json" } }, "description": "Lists all the available namespaces within the ResourceGroup.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespaces by resource group returned successfully", "schema": { "$ref": "#/definitions/RelayNamespaceListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}": { "put": { "tags": [ "Namespaces" ], "operationId": "Namespaces_CreateOrUpdate", "x-ms-examples": { "RelayNamespaceCreate": { "$ref": "./examples/NameSpaces/RelayNameSpaceCreate.json" } }, "description": "Create Azure Relay namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RelayNamespace" }, "description": "Parameters supplied to create a namespace resource." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace create request succeeded.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "201": { "description": "Namespace create request accepted.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Delete", "x-ms-examples": { "RelayNameSpaceDelete": { "$ref": "./examples/NameSpaces/RelayNameSpaceDelete.json" } }, "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace delete request succeeded." }, "202": { "description": "Namespace delete request has been accepted for processing and the operation will complete asynchronously." }, "204": { "description": "Namespace delete request has been accepted, but the namespace was not found." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Get", "x-ms-examples": { "RelayNameSpaceGet": { "$ref": "./examples/NameSpaces/RelayNameSpaceGet.json" } }, "description": "Returns the description for the specified namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace description returned successfully.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Update", "x-ms-examples": { "RelayNameSpaceUpdate": { "$ref": "./examples/NameSpaces/RelayNameSpaceUpdate.json" } }, "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RelayUpdateParameters" }, "description": "Parameters for updating a namespace resource." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace successfuly updated.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "201": { "description": "Namespace update request accepted.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules": { "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_ListAuthorizationRules", "x-ms-examples": { "RelayNameSpaceAutorizationRuleListAll": { "$ref": "./examples/NameSpaces/RelayNameSpaceAutorizationRuleListAll.json" } }, "description": "Authorization rules for a namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace authorization rule returned successfully.", "schema": { "$ref": "#/definitions/AuthorizationRuleListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}": { "put": { "tags": [ "Namespaces" ], "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", "x-ms-examples": { "RelayNameSpaceAuthorizationRuleCreate": { "$ref": "./examples/NameSpaces/RelayNameSpaceAuthorizationRuleCreate.json" } }, "description": "Creates or updates an authorization rule for a namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AuthorizationRule" }, "description": "The authorization rule parameters." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to create namespace authorization rule succeeded.", "schema": { "$ref": "#/definitions/AuthorizationRule" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Namespaces" ], "operationId": "Namespaces_DeleteAuthorizationRule", "x-ms-examples": { "RelayNameSpaceAutorizationRuleDelete": { "$ref": "./examples/NameSpaces/RelayNameSpaceAutorizationRuleDelete.json" } }, "description": "Deletes a namespace authorization rule.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to delete namespace authorization rule succeeded." }, "204": { "description": "No content. The request has been accepted but the namespace authorization rule was not found." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_GetAuthorizationRule", "x-ms-examples": { "RelayNameSpaceAutorizationRuleGet": { "$ref": "./examples/NameSpaces/RelayNameSpaceAutorizationRuleGet.json" } }, "description": "Authorization rule for a namespace by name.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace Authorization rule returned successfully.", "schema": { "$ref": "#/definitions/AuthorizationRule" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys": { "post": { "tags": [ "Namespaces" ], "operationId": "Namespaces_ListKeys", "x-ms-examples": { "RelayNameSpaceAuthorizationRuleListKey": { "$ref": "./examples/NameSpaces/RelayNameSpaceAuthorizationRuleListKey.json" } }, "description": "Primary and secondary connection strings to the namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { "post": { "tags": [ "Namespaces" ], "operationId": "Namespaces_RegenerateKeys", "x-ms-examples": { "RelayNameSpaceAuthorizationRuleRegenrateKey": { "$ref": "./examples/NameSpaces/RelayNameSpaceAuthorizationRuleRegenrateKey.json" } }, "description": "Regenerates the primary or secondary connection strings to the namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RegenerateAccessKeyParameters" }, "description": "Parameters supplied to regenerate authorization rule." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections": { "get": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_ListByNamespace", "x-ms-examples": { "RelayHybridConnectionListAll": { "$ref": "./examples/HybridConnection/RelayHybridConnectionListAll.json" } }, "description": "Lists the hybrid connection within the namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to retrieve hybrid connections by namespace succeeded.", "schema": { "$ref": "#/definitions/HybridConnectionListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}": { "put": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_CreateOrUpdate", "x-ms-examples": { "RelayHybridConnectionCreate": { "$ref": "./examples/HybridConnection/RelayHybridConnectionCreate.json" } }, "description": "Creates or updates a service hybrid connection. This operation is idempotent.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HybridConnection" }, "description": "Parameters supplied to create a hybrid connection." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to create hybrid connections succeeded.", "schema": { "$ref": "#/definitions/HybridConnection" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_Delete", "x-ms-examples": { "RelayHybridconnectionDelete": { "$ref": "./examples/HybridConnection/RelayHybridconnectionDelete.json" } }, "description": "Deletes a hybrid connection.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to delete hybrid connection succeeded." }, "204": { "description": "No content. The request has been accepted but the hybrid connection was not found." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_Get", "x-ms-examples": { "RelayHybridConnectionGet": { "$ref": "./examples/HybridConnection/RelayHybridConnectionGet.json" } }, "description": "Returns the description for the specified hybrid connection.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved description for the hybrid connection.", "schema": { "$ref": "#/definitions/HybridConnection" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules": { "get": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_ListAuthorizationRules", "x-ms-examples": { "RelayHybridConnectionAutorizationRuleListAll": { "$ref": "./examples/HybridConnection/RelayHybridConnectionAutorizationRuleListAll.json" } }, "description": "Authorization rules for a hybrid connection.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Authorization rules successfully returned.", "schema": { "$ref": "#/definitions/AuthorizationRuleListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}": { "put": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_CreateOrUpdateAuthorizationRule", "x-ms-examples": { "RelayHybridConnectionAuthorizationRuleCreate": { "$ref": "./examples/HybridConnection/RelayHybridConnectionAuthorizationRuleCreate.json" } }, "description": "Creates or updates an authorization rule for a hybrid connection.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AuthorizationRule" }, "description": "The authorization rule parameters." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Hybrid connection authorization rule created.", "schema": { "$ref": "#/definitions/AuthorizationRule" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_DeleteAuthorizationRule", "x-ms-examples": { "RelayHybridConnectionAutorizationRuleDelete": { "$ref": "./examples/HybridConnection/RelayHybridConnectionAutorizationRuleDelete.json" } }, "description": "Deletes a hybrid connection authorization rule.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Hybrid connection authorization rule deleted." }, "204": { "description": "Authorization rule does not exist." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_GetAuthorizationRule", "x-ms-examples": { "RelayHybridConnectionAutorizationRuleGet": { "$ref": "./examples/HybridConnection/RelayHybridConnectionAutorizationRuleGet.json" } }, "description": "Hybrid connection authorization rule for a hybrid connection by name.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Hybrid connection authorization rule returned successfully.", "schema": { "$ref": "#/definitions/AuthorizationRule" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys": { "post": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_ListKeys", "x-ms-examples": { "RelayHybridConnectionAuthorizationRuleListKey": { "$ref": "./examples/HybridConnection/RelayHybridConnectionAuthorizationRuleListKey.json" } }, "description": "Primary and secondary connection strings to the hybrid connection.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to retirve connection strings to the hybrid connection succeeded.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { "post": { "tags": [ "HybridConnections" ], "operationId": "HybridConnections_RegenerateKeys", "x-ms-examples": { "RelayHybridConnectionAuthorizationRuleRegenrateKey": { "$ref": "./examples/HybridConnection/RelayHybridConnectionAuthorizationRuleRegenrateKey.json" } }, "description": "Regenerates the primary or secondary connection strings to the hybrid connection.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/hybridConnectionNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RegenerateAccessKeyParameters" }, "description": "Parameters supplied to regenerate authorization rule." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to regenerate connection strings to hybrid connection succeeded.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays": { "get": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_ListByNamespace", "x-ms-examples": { "RelayListAll": { "$ref": "./examples/Relay/RelayListAll.json" } }, "description": "Lists the WCF relays within the namespace.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "WCF relays returned successfully.", "schema": { "$ref": "#/definitions/WcfRelaysListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}": { "put": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_CreateOrUpdate", "x-ms-examples": { "RelayCreate": { "$ref": "./examples/Relay/RelayCreate.json" } }, "description": "Creates or updates a WCF relay. This operation is idempotent.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WcfRelay" }, "description": "Parameters supplied to create a WCF relay." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to create WCF relay succeeded.", "schema": { "$ref": "#/definitions/WcfRelay" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_Delete", "x-ms-examples": { "RelayDelete": { "$ref": "./examples/Relay/RelayDelete.json" } }, "description": "Deletes a WCF relay.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "WCF relay deleted." }, "204": { "description": "No content." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_Get", "x-ms-examples": { "RelayGet": { "$ref": "./examples/Relay/RelayGet.json" } }, "description": "Returns the description for the specified WCF relay.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved WCF relay description.", "schema": { "$ref": "#/definitions/WcfRelay" } }, "204": { "description": "WCF relay not found" }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules": { "get": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_ListAuthorizationRules", "x-ms-examples": { "RelayAutorizationRuleListAll": { "$ref": "./examples/Relay/RelayAutorizationRuleListAll.json" } }, "description": "Authorization rules for a WCF relay.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Authorization rules successfully returned.", "schema": { "$ref": "#/definitions/AuthorizationRuleListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}": { "put": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_CreateOrUpdateAuthorizationRule", "x-ms-examples": { "RelayAuthorizationRuleCreate": { "$ref": "./examples/Relay/RelayAuthorizationRuleCreate.json" } }, "description": "Creates or updates an authorization rule for a WCF relay.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AuthorizationRule" }, "description": "The authorization rule parameters." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "WCF relay authorization rule created.", "schema": { "$ref": "#/definitions/AuthorizationRule" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_DeleteAuthorizationRule", "x-ms-examples": { "RelayAutorizationRuleDelete": { "$ref": "./examples/Relay/RelayAutorizationRuleDelete.json" } }, "description": "Deletes a WCF relay authorization rule.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request to delete WCF relay authorization rule succeeded." }, "204": { "description": "Request accepted butthe authorization rule does not exist." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_GetAuthorizationRule", "x-ms-examples": { "RelayAutorizationRuleGet": { "$ref": "./examples/Relay/RelayAutorizationRuleGet.json" } }, "description": "Get authorizationRule for a WCF relay by name.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request for WCF relay authorization rule succeeded.", "schema": { "$ref": "#/definitions/AuthorizationRule" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/listKeys": { "post": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_ListKeys", "x-ms-examples": { "RelayAuthorizationRuleListKey.json": { "$ref": "./examples/Relay/RelayAuthorizationRuleListKey.json" } }, "description": "Primary and secondary connection strings to the WCF relay.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { "post": { "tags": [ "WCFRelays" ], "operationId": "WCFRelays_RegenerateKeys", "x-ms-examples": { "RelayAuthorizationRuleRegenrateKey.json": { "$ref": "./examples/Relay/RelayAuthorizationRuleRegenrateKey.json" } }, "description": "Regenerates the primary or secondary connection strings to the WCF relay.", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/namespaceNameParameter" }, { "$ref": "#/parameters/relayNameParameter" }, { "$ref": "#/parameters/authorizationRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RegenerateAccessKeyParameters" }, "description": "Parameters supplied to regenerate authorization rule." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful.", "schema": { "$ref": "#/definitions/AccessKeys" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } } }, "definitions": { "TrackedResource": { "properties": { "location": { "type": "string", "x-ms-mutability": [ "read", "create" ], "description": "Resource location." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ], "required": [ "location" ], "description": "Definition of resource." }, "ResourceNamespacePatch": { "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ], "description": "Definition of resource." }, "Resource": { "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource ID." }, "name": { "readOnly": true, "type": "string", "description": "Resource name." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." } }, "description": "The resource definition.", "x-ms-azure-resource": true }, "HybridConnectionListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/HybridConnection" }, "description": "Result of the list hybrid connections." }, "nextLink": { "type": "string", "description": "Link to the next set of results. Not empty if value contains incomplete list hybrid connection operation." } }, "description": "The response of the list hybrid connection operation." }, "HybridConnection": { "properties": { "properties": { "x-ms-client-flatten": true, "properties": { "createdAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "The time the hybrid connection was created." }, "updatedAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "The time the namespace was updated." }, "listenerCount": { "readOnly": true, "format": "int32", "type": "integer", "minimum": 0, "maximum": 25, "description": "The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported." }, "requiresClientAuthorization": { "type": "boolean", "description": "Returns true if client authorization is needed for this hybrid connection; otherwise, false." }, "userMetadata": { "type": "string", "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." } }, "description": "Properties of the HybridConnection." } }, "description": "Description of hybrid connection resource.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "WcfRelaysListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WcfRelay" }, "description": "Result of the list WCF relay operation." }, "nextLink": { "type": "string", "description": "Link to the next set of results. Not empty if value contains incomplete list of WCF relays." } }, "description": "The response of the list WCF relay operation." }, "WcfRelay": { "properties": { "properties": { "x-ms-client-flatten": true, "properties": { "isDynamic": { "readOnly": true, "type": "boolean", "description": "Returns true if the relay is dynamic; otherwise, false." }, "createdAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "The time the WCF relay was created." }, "updatedAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "The time the namespace was updated." }, "listenerCount": { "readOnly": true, "format": "int32", "type": "integer", "minimum": 0, "maximum": 25, "description": "The number of listeners for this relay. Note that min :1 and max:25 are supported." }, "relayType": { "type": "string", "description": "WCF relay type.", "enum": [ "NetTcp", "Http" ], "x-ms-enum": { "name": "Relaytype", "modelAsString": false } }, "requiresClientAuthorization": { "type": "boolean", "description": "Returns true if client authorization is needed for this relay; otherwise, false." }, "requiresTransportSecurity": { "type": "boolean", "description": "Returns true if transport security is needed for this relay; otherwise, false." }, "userMetadata": { "type": "string", "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." } }, "description": "Properties of the WCF relay." } }, "description": "Description of the WCF relay resource.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "RelayNamespaceListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RelayNamespace" }, "description": "Result of the list namespace operation." }, "nextLink": { "type": "string", "description": "Link to the next set of results. Not empty if value contains incomplete list of namespaces." } }, "description": "The response from the list namespace operation." }, "RelayNamespace": { "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "SKU of the namespace." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RelayNamespaceProperties", "description": "Description of Relay namespace" } }, "description": "Description of a namespace resource.", "allOf": [ { "$ref": "#/definitions/TrackedResource" } ] }, "RelayNamespaceProperties": { "properties": { "provisioningState": { "type": "string", "readOnly": true, "enum": [ "Created", "Succeeded", "Deleted", "Failed", "Updating", "Unknown" ], "x-ms-enum": { "name": "provisioningStateEnum", "modelAsString": false } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "The time the namespace was created." }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "The time the namespace was updated." }, "serviceBusEndpoint": { "type": "string", "readOnly": true, "description": "Endpoint you can use to perform Service Bus operations." }, "metricId": { "type": "string", "readOnly": true, "description": "Identifier for Azure Insights metrics." } }, "description": "Properties of the namespace." }, "RelayUpdateParameters": { "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "SKU of the namespace." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RelayNamespaceProperties", "description": "Description of Relay namespace." } }, "description": "Description of a namespace resource.", "allOf": [ { "$ref": "#/definitions/ResourceNamespacePatch" } ] }, "Sku": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of this SKU.", "enum": [ "Standard" ], "x-ms-enum": { "name": "SkuName", "modelAsString": false } }, "tier": { "type": "string", "description": "The tier of this SKU.", "enum": [ "Standard" ], "x-ms-enum": { "name": "SkuTier", "modelAsString": false } } }, "description": "SKU of the namespace.", "required": [ "name" ] }, "AuthorizationRuleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AuthorizationRule" }, "description": "Result of the list authorization rules operation." }, "nextLink": { "type": "string", "description": "Link to the next set of results. Not empty if value contains incomplete list of authorization rules." } }, "description": "The response from the list namespace operation." }, "AuthorizationRule": { "properties": { "properties": { "x-ms-client-flatten": true, "properties": { "rights": { "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "Manage", "Send", "Listen" ], "x-ms-enum": { "name": "AccessRights", "modelAsString": false } }, "description": "The rights associated with the rule." } }, "required": [ "rights" ], "description": "Authorization rule properties." } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/definitions/Resource" } ], "description": "Description of a namespace authorization rule." }, "AccessKeys": { "properties": { "primaryConnectionString": { "type": "string", "description": "Primary connection string of the created namespace authorization rule." }, "secondaryConnectionString": { "type": "string", "description": "Secondary connection string of the created namespace authorization rule." }, "primaryKey": { "type": "string", "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." }, "secondaryKey": { "type": "string", "description": "A base64-encoded 256-bit secondary key for signing and validating the SAS token." }, "keyName": { "type": "string", "description": "A string that describes the authorization rule." } }, "description": "Namespace/Relay Connection String" }, "RegenerateAccessKeyParameters": { "properties": { "keyType": { "type": "string", "description": "The access key to regenerate.", "enum": [ "PrimaryKey", "SecondaryKey" ], "x-ms-enum": { "name": "KeyType", "modelAsString": false } }, "key": { "type": "string", "description": "Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type." } }, "required": [ "keyType" ], "description": "Parameters supplied to the regenerate authorization rule operation, specifies which key neeeds to be reset." }, "UnavailableReason": { "type": "string", "enum": [ "None", "InvalidName", "SubscriptionIsDisabled", "NameInUse", "NameInLockdown", "TooManyNamespaceInCurrentSubscription" ], "x-ms-enum": { "name": "UnavailableReason", "modelAsString": false }, "description": "Specifies the reason for the unavailability of the service." }, "CheckNameAvailability": { "properties": { "name": { "type": "string", "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": [ "name" ], "description": "Description of the check name availability request properties." }, "CheckNameAvailabilityResult": { "properties": { "message": { "type": "string", "readOnly": true, "description": "The detailed info regarding the reason associated with the namespace." }, "nameAvailable": { "type": "boolean", "description": "Value indicating namespace is available. Returns true if the namespace is available; otherwise, false." }, "reason": { "$ref": "#/definitions/UnavailableReason", "description": "The reason for unavailability of a namespace." } }, "description": "Description of the check name availability request properties." }, "OperationListResult": { "description": "Result of the request to list Relay operations. It contains a list of operations and a URL link to get the next set of results.", "properties": { "value": { "description": "List of Relay operations supported by resource provider.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Operation" }, "x-ms-identifiers": [ "name" ] }, "nextLink": { "description": "URL to get the next set of operation list results if there are any.", "type": "string", "readOnly": true } } }, "Operation": { "description": "A Relay REST API operation.", "type": "object", "properties": { "name": { "description": "Operation name: {provider}/{resource}/{operation}", "type": "string", "readOnly": true }, "display": { "description": "The object that represents the operation.", "properties": { "provider": { "description": "Service provider: Relay.", "type": "string", "readOnly": true }, "resource": { "description": "Resource on which the operation is performed: Invoice, etc.", "type": "string", "readOnly": true }, "operation": { "description": "Operation type: Read, write, delete, etc.", "type": "string", "readOnly": true } } } } }, "ErrorResponse": { "description": "Error reponse indicates Relay service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { "description": "Error code.", "type": "string" }, "message": { "description": "Error message indicating why the operation failed.", "type": "string" } } } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client API version." }, "resourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "x-ms-parameter-location": "method", "description": "Name of the Resource group within the Azure subscription." }, "namespaceNameParameter": { "name": "namespaceName", "in": "path", "required": true, "type": "string", "minLength": 6, "maxLength": 50, "x-ms-parameter-location": "method", "description": "The namespace name" }, "hybridConnectionNameParameter": { "name": "hybridConnectionName", "in": "path", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", "description": "The hybrid connection name." }, "authorizationRuleNameParameter": { "name": "authorizationRuleName", "in": "path", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", "description": "The authorization rule name." }, "relayNameParameter": { "name": "relayName", "in": "path", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", "description": "The relay name." } } }