{ "swagger": "2.0", "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs 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.EventHub/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability Namespaces" ], "operationId": "Namespaces_CheckNameAvailability", "x-ms-examples": { "NamespacesCheckNameAvailability": { "$ref": "./examples/NameSpaces/EHNameSpaceCheckNameAvailability.json" } }, "description": "Check the give Namespace name availability.", "parameters": [ { "$ref": "./common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailabilityParameter" }, "description": "Parameters to check availability of the given Namespace name" } ], "responses": { "200": { "description": "check availability returned successfully.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { "$ref": "./common/v2/definitions.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "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." }, "CheckNameAvailabilityParameter": { "properties": { "name": { "type": "string", "description": "Name to check the namespace name availability" } }, "required": [ "name" ], "description": "Parameter supplied to check Namespace name availability operation " }, "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 availability, true if the Namespace is available; otherwise, false." }, "reason": { "$ref": "#/definitions/UnavailableReason", "description": "The reason for unavailability of a Namespace." } }, "description": "The Result of the CheckNameAvailability operation" } }, "parameters": {} }