|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "title": "EventHubManagementClient", |
| 5 | + "description": "Azure Event Hubs client", |
| 6 | + "version": "2021-06-01-preview" |
| 7 | + }, |
| 8 | + "host": "management.azure.com", |
| 9 | + "schemes": [ |
| 10 | + "https" |
| 11 | + ], |
| 12 | + "consumes": [ |
| 13 | + "application/json" |
| 14 | + ], |
| 15 | + "produces": [ |
| 16 | + "application/json" |
| 17 | + ], |
| 18 | + "security": [ |
| 19 | + { |
| 20 | + "azure_auth": [ |
| 21 | + "user_impersonation" |
| 22 | + ] |
| 23 | + } |
| 24 | + ], |
| 25 | + "securityDefinitions": { |
| 26 | + "azure_auth": { |
| 27 | + "type": "oauth2", |
| 28 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 29 | + "flow": "implicit", |
| 30 | + "description": "Azure Active Directory OAuth2 Flow", |
| 31 | + "scopes": { |
| 32 | + "user_impersonation": "impersonate your user account" |
| 33 | + } |
| 34 | + } |
| 35 | + }, |
| 36 | + "paths": { |
| 37 | + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/checkNameAvailability": { |
| 38 | + "post": { |
| 39 | + "tags": [ |
| 40 | + "CheckNameAvailability Namespaces" |
| 41 | + ], |
| 42 | + "operationId": "Namespaces_CheckNameAvailability", |
| 43 | + "x-ms-examples": { |
| 44 | + "NamespacesCheckNameAvailability": { |
| 45 | + "$ref": "./examples/NameSpaces/EHNameSpaceCheckNameAvailability.json" |
| 46 | + } |
| 47 | + }, |
| 48 | + "description": "Check the give Namespace name availability.", |
| 49 | + "parameters": [ |
| 50 | + { |
| 51 | + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" |
| 52 | + }, |
| 53 | + { |
| 54 | + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" |
| 55 | + }, |
| 56 | + { |
| 57 | + "name": "parameters", |
| 58 | + "in": "body", |
| 59 | + "required": true, |
| 60 | + "schema": { |
| 61 | + "$ref": "#/definitions/CheckNameAvailabilityParameter" |
| 62 | + }, |
| 63 | + "description": "Parameters to check availability of the given Namespace name" |
| 64 | + } |
| 65 | + ], |
| 66 | + "responses": { |
| 67 | + "200": { |
| 68 | + "description": "check availability returned successfully.", |
| 69 | + "schema": { |
| 70 | + "$ref": "#/definitions/CheckNameAvailabilityResult" |
| 71 | + } |
| 72 | + }, |
| 73 | + "default": { |
| 74 | + "description": "Eventhub error response describing why the operation failed.", |
| 75 | + "schema": { |
| 76 | + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" |
| 77 | + } |
| 78 | + } |
| 79 | + } |
| 80 | + } |
| 81 | + } |
| 82 | + }, |
| 83 | + "definitions": { |
| 84 | + "UnavailableReason": { |
| 85 | + "type": "string", |
| 86 | + "enum": [ |
| 87 | + "None", |
| 88 | + "InvalidName", |
| 89 | + "SubscriptionIsDisabled", |
| 90 | + "NameInUse", |
| 91 | + "NameInLockdown", |
| 92 | + "TooManyNamespaceInCurrentSubscription" |
| 93 | + ], |
| 94 | + "x-ms-enum": { |
| 95 | + "name": "UnavailableReason", |
| 96 | + "modelAsString": false |
| 97 | + }, |
| 98 | + "description": "Specifies the reason for the unavailability of the service." |
| 99 | + }, |
| 100 | + "CheckNameAvailabilityParameter": { |
| 101 | + "properties": { |
| 102 | + "name": { |
| 103 | + "type": "string", |
| 104 | + "description": "Name to check the namespace name availability" |
| 105 | + } |
| 106 | + }, |
| 107 | + "required": [ |
| 108 | + "name" |
| 109 | + ], |
| 110 | + "description": "Parameter supplied to check Namespace name availability operation " |
| 111 | + }, |
| 112 | + "CheckNameAvailabilityResult": { |
| 113 | + "properties": { |
| 114 | + "message": { |
| 115 | + "type": "string", |
| 116 | + "readOnly": true, |
| 117 | + "description": "The detailed info regarding the reason associated with the Namespace." |
| 118 | + }, |
| 119 | + "nameAvailable": { |
| 120 | + "type": "boolean", |
| 121 | + "description": "Value indicating Namespace is availability, true if the Namespace is available; otherwise, false." |
| 122 | + }, |
| 123 | + "reason": { |
| 124 | + "$ref": "#/definitions/UnavailableReason", |
| 125 | + "description": "The reason for unavailability of a Namespace." |
| 126 | + } |
| 127 | + }, |
| 128 | + "description": "The Result of the CheckNameAvailability operation" |
| 129 | + } |
| 130 | + }, |
| 131 | + "parameters": {} |
| 132 | +} |
0 commit comments