{ "swagger": "2.0", "info": { "title": "ServiceBusManagementClient", "description": "Azure Service Bus client", "version": "2024-01-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/CheckNameAvailability": { "post": { "tags": [ "Namespaces" ], "operationId": "Namespaces_CheckNameAvailability", "x-ms-examples": { "NameSpaceCheckNameAvailability": { "$ref": "./examples/NameSpaces/SBNameSpaceCheckNameAvailability.json" } }, "description": "Check the give namespace name availability.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailability" }, "description": "Parameters to check availability of the given namespace name" } ], "responses": { "200": { "description": "check availability returned successfully.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { "post": { "tags": [ "DisasterRecoveryConfigs" ], "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", "x-ms-examples": { "AliasNameAvailability": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json" } }, "description": "Check the give namespace name availability.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailability" }, "description": "Parameters to check availability of the given namespace name" } ], "responses": { "200": { "description": "check availability returned successfully.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "CheckNameAvailability": { "type": "object", "properties": { "name": { "type": "string", "description": "The Name to check the namespace name availability and 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 a Check Name availability request properties." }, "CheckNameAvailabilityResult": { "type": "object", "properties": { "message": { "readOnly": true, "type": "string", "description": "The detailed info regarding the reason associated with the namespace." }, "nameAvailable": { "type": "boolean", "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." }, "reason": { "$ref": "#/definitions/UnavailableReason", "description": "The reason for unavailability of a namespace." } }, "description": "Description of a Check Name availability request properties." }, "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." } }, "parameters": {} }