{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-relay","description":"Relay API","version":"2017-04-01","base_url":"https://management.azure.com","endpoints":34,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Relay API\n@base https://management.azure.com\n@version 2017-04-01\n@auth OAuth2\n@common_fields {api-version: any # Client API version., subscriptionId: any # Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}\n@endpoints 34\n@hint download_for_search\n@toc providers(1), subscriptions(33)\n\n@group providers\n@endpoint GET /providers/Microsoft.Relay/operations\n@desc Lists all available Relay REST API operations.\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability\n@desc Check the specified namespace name availability.\n@required {parameters: any # Parameters to check availability of the specified namespace name.}\n@returns(200) Check availability returned successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces\n@desc Lists all the available namespaces within the subscription regardless of the resourceGroups.\n@returns(200) Namespaces returned successfully\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces\n@desc Lists all the available namespaces within the ResourceGroup.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription.}\n@returns(200) Namespaces by resource group returned successfully\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}\n@desc Create Azure Relay namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, parameters: any # Parameters supplied to create a namespace resource.}\n@returns(200) Namespace create request succeeded.\n@returns(201) Namespace create request accepted.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}\n@desc Deletes an existing namespace. This operation also removes all associated resources under the namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name}\n@returns(200) Namespace delete request succeeded.\n@returns(202) Namespace delete request has been accepted for processing and the operation will complete asynchronously.\n@returns(204) Namespace delete request has been accepted, but the namespace was not found.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}\n@desc Returns the description for the specified namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name}\n@returns(200) Namespace description returned successfully.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}\n@desc Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, parameters: any # Parameters for updating a namespace resource.}\n@returns(200) Namespace successfuly updated.\n@returns(201) Namespace update request accepted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules\n@desc Authorization rules for a namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name}\n@returns(200) Namespace authorization rule returned successfully.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}\n@desc Creates or updates an authorization rule for a namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, authorizationRuleName: any # The authorization rule name., parameters: any # The authorization rule parameters.}\n@returns(200) Request to create namespace authorization rule succeeded.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}\n@desc Deletes a namespace authorization rule.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, authorizationRuleName: any # The authorization rule name.}\n@returns(200) Request to delete namespace authorization rule succeeded.\n@returns(204) No content. The request has been accepted but the namespace authorization rule was not found.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}\n@desc Authorization rule for a namespace by name.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, authorizationRuleName: any # The authorization rule name.}\n@returns(200) Namespace Authorization rule returned successfully.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys\n@desc Primary and secondary connection strings to the namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, authorizationRuleName: any # The authorization rule name.}\n@returns(200) Successful.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys\n@desc Regenerates the primary or secondary connection strings to the namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, authorizationRuleName: any # The authorization rule name., parameters: any # Parameters supplied to regenerate authorization rule.}\n@returns(200) Successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections\n@desc Lists the hybrid connection within the namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name}\n@returns(200) Request to retrieve hybrid connections by namespace succeeded.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}\n@desc Creates or updates a service hybrid connection. This operation is idempotent.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name., parameters: any # Parameters supplied to create a hybrid connection.}\n@returns(200) Request to create hybrid connections succeeded.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}\n@desc Deletes a hybrid connection.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name.}\n@returns(200) Request to delete hybrid connection succeeded.\n@returns(204) No content. The request has been accepted but the hybrid connection was not found.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}\n@desc Returns the description for the specified hybrid connection.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name.}\n@returns(200) Successfully retrieved description for the hybrid connection.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules\n@desc Authorization rules for a hybrid connection.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name.}\n@returns(200) Authorization rules successfully returned.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}\n@desc Creates or updates an authorization rule for a hybrid connection.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name., authorizationRuleName: any # The authorization rule name., parameters: any # The authorization rule parameters.}\n@returns(200) Hybrid connection authorization rule created.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}\n@desc Deletes a hybrid connection authorization rule.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name., authorizationRuleName: any # The authorization rule name.}\n@returns(200) Hybrid connection authorization rule deleted.\n@returns(204) Authorization rule does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}\n@desc Hybrid connection authorization rule for a hybrid connection by name.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name., authorizationRuleName: any # The authorization rule name.}\n@returns(200) Hybrid connection authorization rule returned successfully.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys\n@desc Primary and secondary connection strings to the hybrid connection.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name., authorizationRuleName: any # The authorization rule name.}\n@returns(200) Request to retirve connection strings to the hybrid connection succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/regenerateKeys\n@desc Regenerates the primary or secondary connection strings to the hybrid connection.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, hybridConnectionName: any # The hybrid connection name., authorizationRuleName: any # The authorization rule name., parameters: any # Parameters supplied to regenerate authorization rule.}\n@returns(200) Request to regenerate connection strings to hybrid connection succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays\n@desc Lists the WCF relays within the namespace.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name}\n@returns(200) WCF relays returned successfully.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}\n@desc Creates or updates a WCF relay. This operation is idempotent.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name., parameters: any # Parameters supplied to create a WCF relay.}\n@returns(200) Request to create WCF relay succeeded.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}\n@desc Deletes a WCF relay.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name.}\n@returns(200) WCF relay deleted.\n@returns(204) No content.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}\n@desc Returns the description for the specified WCF relay.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name.}\n@returns(200) Successfully retrieved WCF relay description.\n@returns(204) WCF relay not found\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules\n@desc Authorization rules for a WCF relay.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name.}\n@returns(200) Authorization rules successfully returned.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}\n@desc Creates or updates an authorization rule for a WCF relay.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name., authorizationRuleName: any # The authorization rule name., parameters: any # The authorization rule parameters.}\n@returns(200) WCF relay authorization rule created.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}\n@desc Deletes a WCF relay authorization rule.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name., authorizationRuleName: any # The authorization rule name.}\n@returns(200) Request to delete WCF relay authorization rule succeeded.\n@returns(204) Request accepted butthe authorization rule does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}\n@desc Get authorizationRule for a WCF relay by name.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name., authorizationRuleName: any # The authorization rule name.}\n@returns(200) Request for WCF relay authorization rule succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/listKeys\n@desc Primary and secondary connection strings to the WCF relay.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name., authorizationRuleName: any # The authorization rule name.}\n@returns(200) Successful.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/regenerateKeys\n@desc Regenerates the primary or secondary connection strings to the WCF relay.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., namespaceName: any # The namespace name, relayName: any # The relay name., authorizationRuleName: any # The authorization rule name., parameters: any # Parameters supplied to regenerate authorization rule.}\n@returns(200) Successful.\n\n@endgroup\n\n@end\n"}