{ "swagger": "2.0", "info": { "title": "ServiceBusManagementClient", "description": "Azure Service Bus client", "version": "2017-04-01" }, "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": { "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_List", "x-ms-examples": { "NameSpaceList": { "$ref": "./examples/NameSpaces/SBNameSpaceList.json" } }, "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespaces successfully returned.", "schema": { "$ref": "#/definitions/SBNamespaceListResult" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_ListByResourceGroup", "x-ms-examples": { "NameSpaceListByResourceGroup": { "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" } }, "description": "Gets the available namespaces within a resource group.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespaces successfully returned.", "schema": { "$ref": "#/definitions/SBNamespaceListResult" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { "put": { "tags": [ "Namespaces" ], "operationId": "Namespaces_CreateOrUpdate", "x-ms-examples": { "NameSpaceCreate": { "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" } }, "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "name": "namespaceName", "in": "path", "required": true, "type": "string", "description": "The namespace name." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SBNamespace" }, "description": "Parameters supplied to create a namespace resource." }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace created successfully.", "schema": { "$ref": "#/definitions/SBNamespace" } }, "201": { "description": "Namespace create request accepted.", "schema": { "$ref": "#/definitions/SBNamespace" } }, "202": { "description": "Namespace create or update request accepted." }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Delete", "x-ms-examples": { "NameSpaceDelete": { "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" } }, "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace successfully deleted." }, "202": { "description": "Namespace delete request accepted." }, "204": { "description": "No content." }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Get", "x-ms-examples": { "NameSpaceGet": { "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" } }, "description": "Gets a description for the specified namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace successfully returned.", "schema": { "$ref": "#/definitions/SBNamespace" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Update", "x-ms-examples": { "NameSpaceUpdate": { "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" } }, "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SBNamespaceUpdateParameters" }, "description": "Parameters supplied to update a namespace resource." }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace updated successfully.", "schema": { "$ref": "#/definitions/SBNamespace" } }, "201": { "description": "Namespace update request accepted.", "schema": { "$ref": "#/definitions/SBNamespace" } }, "202": { "description": "Namespace update request accepted." }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "ResourceNamespacePatch": { "properties": { "location": { "type": "string", "description": "Resource location" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags" } }, "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/Resource" } ], "description": "The Resource definition." }, "SBNamespaceListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/SBNamespace" }, "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 of the List Namespace operation." }, "SBNamespace": { "properties": { "sku": { "$ref": "#/definitions/SBSku", "description": "Properties of Sku" }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SBNamespaceProperties", "description": "Properties of the namespace." } }, "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" } ], "description": "Description of a namespace resource." }, "SBNamespaceUpdateParameters": { "properties": { "sku": { "$ref": "#/definitions/SBSku", "description": "Properties of Sku" }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SBNamespaceProperties", "description": "Properties of the namespace." } }, "allOf": [ { "$ref": "#/definitions/ResourceNamespacePatch" } ], "description": "Description of a namespace resource." }, "SBNamespaceProperties": { "properties": { "provisioningState": { "readOnly": true, "type": "string", "description": "Provisioning state of the namespace." }, "createdAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "The time the namespace was created." }, "updatedAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "The time the namespace was updated." }, "serviceBusEndpoint": { "readOnly": true, "type": "string", "description": "Endpoint you can use to perform Service Bus operations." }, "metricId": { "readOnly": true, "type": "string", "description": "Identifier for Azure Insights metrics" } }, "description": "Properties of the namespace." }, "SBSku": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of this SKU.", "enum": [ "Basic", "Standard", "Premium" ], "x-ms-enum": { "name": "SkuName", "modelAsString": false } }, "tier": { "type": "string", "description": "The billing tier of this particular SKU.", "enum": [ "Basic", "Standard", "Premium" ], "x-ms-enum": { "name": "SkuTier", "modelAsString": false } }, "capacity": { "format": "int32", "type": "integer", "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." } }, "required": [ "name" ], "description": "SKU of the namespace." } }, "parameters": {} }