diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/common/v1/definitions.json b/specification/eventhub/resource-manager/Microsoft.EventHub/common/v1/definitions.json new file mode 100644 index 000000000000..195b5900769a --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/common/v1/definitions.json @@ -0,0 +1,221 @@ +{ + "swagger": "2.0", + "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" + } + } + }, + "info": { + "version": "2017-04-01", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "TrackedResource": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Definition of resource." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "description": "The resource definition.", + "x-ms-azure-resource": true + }, + "ErrorResponse": { + "description": "Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the resource group within the azure subscription." + }, + "NamespaceNameParameter": { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The Namespace name" + }, + "EventHubNameParameter": { + "name": "eventHubName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The Event Hub name" + }, + "ConsumerGroupNameParameter": { + "name": "consumerGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The consumer group name" + }, + "SkipParameter": { + "name": "$skip", + "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "AuthorizationRuleNameParameter": { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The authorization rule name." + }, + "AliasNameParameter": { + "name": "alias", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The Disaster Recovery configuration name" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The name of the Event Hubs Cluster." + }, + "IpFilterRuleNameParameter": { + "name": "ipFilterRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The IP Filter Rule name." + }, + "VirtualNetworkRuleNameParameter": { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The Virtual Network Rule name." + }, + "SkuNameParameter": { + "name": "sku", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The sku type." + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json new file mode 100644 index 000000000000..a31517c688e1 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json @@ -0,0 +1,98 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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/availableClusterRegions": { + "get": { + "tags": [ + "Event Hubs Clusters" + ], + "operationId": "Clusters_ListAvailableClusters", + "x-ms-examples": { + "ListAvailableClusters": { + "$ref": "./examples/Clusters/ListAvailableClustersGet.json" + } + }, + "description": "List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Available clusters listed successfully.", + "schema": { + "$ref": "#/definitions/AvailableClustersList" + } + }, + "default": { + "description": "Error response describing why available clusters could not be successfully listed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AvailableClustersList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableCluster" + }, + "description": "The count of readily available and pre-provisioned Event Hubs Clusters per region." + } + }, + "description": "The response of the List Available Clusters operation." + }, + "AvailableCluster": { + "properties": { + "location": { + "type": "string", + "description": "Location fo the Available Cluster" + } + }, + "description": "Pre-provisioned and readily available Event Hubs Cluster count per region." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json new file mode 100644 index 000000000000..5e7ae741920c --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json @@ -0,0 +1,425 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { + "get": { + "tags": [ + "Event Hubs Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "ClustersListByResourceGroup": { + "$ref": "./examples/Clusters/ClustersListByResourceGroup.json" + } + }, + "description": "Lists the available Event Hubs Clusters within an ARM resource group.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Clusters returned successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Event Hub Cluster 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.EventHub/clusters/{clusterName}": { + "get": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "ClusterGet": { + "$ref": "./examples/Clusters/ClusterGet.json" + } + }, + "description": "Gets the resource description of the specified Event Hubs Cluster.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster resource description returned successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Put", + "x-ms-examples": { + "ClusterPut": { + "$ref": "./examples/Clusters/ClusterPut.json" + } + }, + "description": "Creates or updates an instance of an Event Hubs Cluster.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster successfully created or updated.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Event Hubs Cluster create or update request accepted.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Event Hubs Cluster create or update request accepted." + }, + "default": { + "description": "Event Hubs error response detailing why the Event Hubs Cluster create or update operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Patch", + "x-ms-examples": { + "ClusterPatch": { + "$ref": "./examples/Clusters/ClusterPatch.json" + } + }, + "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "The properties of the Event Hubs Cluster which should be updated." + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster successfully created.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Event Hubs Cluster update request accepted.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Event Hubs Cluster update request accepted." + }, + "default": { + "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "ClusterDelete": { + "$ref": "./examples/Clusters/ClusterDelete.json" + } + }, + "description": "Deletes an existing Event Hubs Cluster. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster successfully deleted." + }, + "202": { + "description": "Event Hubs Cluster delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Event Hubs error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces": { + "get": { + "tags": [ + "Event Hubs Namespace Enumeration in Cluster" + ], + "operationId": "Clusters_ListNamespaces", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.", + "x-ms-examples": { + "ListNamespacesInCluster": { + "$ref": "./examples/Clusters/ListNamespacesInClusterGet.json" + } + }, + "responses": { + "200": { + "description": "List of Namespace IDs in Cluster successfully delivered.", + "schema": { + "$ref": "#/definitions/EHNamespaceIdListResult" + } + }, + "default": { + "description": "Event Hubs Cluster error response detailing why this operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Cluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ClusterSku", + "description": "Properties of the cluster SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "created": { + "readOnly": true, + "type": "string", + "description": "The UTC time when the Event Hubs Cluster was created." + }, + "updated": { + "readOnly": true, + "type": "string", + "description": "The UTC time when the Event Hubs Cluster was last updated." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "The metric ID of the cluster resource. Provided by the service and not modifiable by the user." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the Cluster resource" + } + }, + "description": "Event Hubs Cluster properties supplied in responses in List or Get operations." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Single Event Hubs Cluster resource in List or Get operations." + }, + "ClusterSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Dedicated" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 32, + "minimum": 1, + "type": "integer", + "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters particular to a cluster instance." + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "The Event Hubs Clusters present in the List Event Hubs operation results." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters." + } + }, + "description": "The response of the List Event Hubs Clusters operation." + }, + "EHNamespaceIdListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespaceIdContainer" + }, + "description": "Result of the List Namespace IDs operation" + } + }, + "description": "The response of the List Namespace IDs operation" + }, + "EHNamespaceIdContainer": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "id parameter" + } + }, + "description": "The full ARM ID of an Event Hubs Namespace" + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json deleted file mode 100644 index cef1828ec89b..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json +++ /dev/null @@ -1,1972 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHub2018PreviewManagementClient", - "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", - "version": "2018-01-01-preview" - }, - "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": { - "/providers/Microsoft.EventHub/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "x-ms-examples": { - "EHOperations_List": { - "$ref": "./examples/Operations_List.json" - } - }, - "description": "Lists all of the available Event Hub REST API operations.", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/availableClusterRegions": { - "get": { - "tags": [ - "Event Hubs Clusters" - ], - "operationId": "Clusters_ListAvailableClusters", - "x-ms-examples": { - "ListAvailableClusters": { - "$ref": "./examples/Clusters/ListAvailableClustersGet.json" - } - }, - "description": "List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available clusters listed successfully.", - "schema": { - "$ref": "#/definitions/AvailableClustersList" - } - }, - "default": { - "description": "Error response describing why available clusters could not be successfully listed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { - "get": { - "tags": [ - "Event Hubs Clusters" - ], - "operationId": "Clusters_ListByResourceGroup", - "x-ms-examples": { - "ClustersListByResourceGroup": { - "$ref": "./examples/Clusters/ClustersListByResourceGroup.json" - } - }, - "description": "Lists the available Event Hubs Clusters within an ARM resource group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Clusters returned successfully.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Event Hub Cluster error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}": { - "get": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Get", - "x-ms-examples": { - "ClusterGet": { - "$ref": "./examples/Clusters/ClusterGet.json" - } - }, - "description": "Gets the resource description of the specified Event Hubs Cluster.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster resource description returned successfully.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Put", - "x-ms-examples": { - "ClusterPut": { - "$ref": "./examples/Clusters/ClusterPut.json" - } - }, - "description": "Creates or updates an instance of an Event Hubs Cluster.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully created or updated.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "Event Hubs Cluster create or update request accepted.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Event Hubs Cluster create or update request accepted." - }, - "default": { - "description": "Event Hubs error response detailing why the Event Hubs Cluster create or update operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Patch", - "x-ms-examples": { - "ClusterPatch": { - "$ref": "./examples/Clusters/ClusterPatch.json" - } - }, - "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - }, - "description": "The properties of the Event Hubs Cluster which should be updated." - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully created.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "Event Hubs Cluster update request accepted.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Delete", - "x-ms-examples": { - "ClusterDelete": { - "$ref": "./examples/Clusters/ClusterDelete.json" - } - }, - "description": "Deletes an existing Event Hubs Cluster. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully deleted." - }, - "202": { - "description": "Event Hubs Cluster delete request accepted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Event Hubs error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces": { - "get": { - "tags": [ - "Event Hubs Namespace Enumeration in Cluster" - ], - "operationId": "Clusters_ListNamespaces", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "description": "List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.", - "x-ms-examples": { - "ListNamespacesInCluster": { - "$ref": "./examples/Clusters/ListNamespacesInClusterGet.json" - } - }, - "responses": { - "200": { - "description": "List of Namespace IDs in Cluster successfully delivered.", - "schema": { - "$ref": "#/definitions/EHNamespaceIdListResult" - } - }, - "default": { - "description": "Event Hubs Cluster error response detailing why this operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { - "patch": { - "tags": [ - "Event Hubs Cluster Configuration" - ], - "operationId": "Configuration_Patch", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties", - "required": [ - "settings" - ] - }, - "description": "Parameters for creating an Event Hubs Cluster resource." - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationPatch": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationPatch.json" - } - }, - "description": "Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "201": { - "description": "Event Hubs Cluster setting configuration request successfully accepted.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Event Hubs Cluster Configuration" - ], - "operationId": "Configuration_Get", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationGet": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationGet.json" - } - }, - "description": "Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_List", - "x-ms-examples": { - "NamespacesListBySubscription": { - "$ref": "./examples/NameSpaces/EHNameSpaceList.json" - } - }, - "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListByResourceGroup", - "x-ms-examples": { - "NamespaceListByResourceGroup": { - "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" - } - }, - "description": "Lists the available Namespaces within a resource group.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdate", - "x-ms-examples": { - "NamespaceCreate": { - "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace", - "required": [ - "location" - ] - }, - "description": "Parameters for creating a namespace resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully created.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "201": { - "description": "Namespace create request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Delete", - "x-ms-examples": { - "NameSpaceDelete": { - "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" - } - }, - "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully deleted." - }, - "202": { - "description": "Namespace delete request accepted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Get", - "x-ms-examples": { - "NameSpaceGet": { - "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" - } - }, - "description": "Gets the description of the specified namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Update", - "x-ms-examples": { - "NamespacesUpdate": { - "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace" - }, - "description": "Parameters for updating a namespace resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully updated.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListIPFilterRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json" - } - }, - "description": "Gets a list of IP Filter rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule successfully returned.", - "schema": { - "$ref": "#/definitions/IpFilterRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleCreate": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/ipFilterRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "The Namespace IpFilterRule." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule created", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleDelete": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json" - } - }, - "description": "Deletes an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/ipFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule successfully deleted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleGet": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json" - } - }, - "description": "Gets an IpFilterRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/ipFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule returned successfully.", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListVirtualNetworkRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json" - } - }, - "description": "Gets a list of VirtualNetwork rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule successfully returned.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/virtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "The Namespace VirtualNetworkRule." - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule created", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleDelete": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json" - } - }, - "description": "Deletes an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/virtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule successfully deleted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json" - } - }, - "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/virtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule returned successfully.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default": { - "put": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json" - } - }, - "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", - "description": "Create or update NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - }, - "description": "The Namespace IpFilterRule." - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json" - } - }, - "operationId": "Namespaces_GetNetworkRuleSet", - "description": "Gets NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "description": "List of Event Hub operations supported by the Microsoft.EventHub resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "A Event Hub REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{operation}" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "Service provider: Microsoft.EventHub" - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "Resource on which the operation is performed: Invoice, etc." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "Operation type: Read, write, delete, etc." - } - } - } - } - }, - "Cluster": { - "properties": { - "sku": { - "$ref": "#/definitions/ClusterSku", - "description": "Properties of the cluster SKU." - }, - "properties": { - "x-ms-client-flatten": true, - "properties": { - "created": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was created." - }, - "updated": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was last updated." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "The metric ID of the cluster resource. Provided by the service and not modifiable by the user." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "Status of the Cluster resource" - } - }, - "description": "Event Hubs Cluster properties supplied in responses in List or Get operations." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Single Event Hubs Cluster resource in List or Get operations." - }, - "AvailableClustersList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AvailableCluster" - }, - "description": "The count of readily available and pre-provisioned Event Hubs Clusters per region." - } - }, - "description": "The response of the List Available Clusters operation." - }, - "AvailableCluster": { - "properties": { - "location": { - "type": "string", - "description": "Location fo the Available Cluster" - } - }, - "description": "Pre-provisioned and readily available Event Hubs Cluster count per region." - }, - "ClusterListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The Event Hubs Clusters present in the List Event Hubs operation results." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters." - } - }, - "description": "The response of the List Event Hubs Clusters operation." - }, - "ClusterQuotaConfigurationProperties": { - "properties": { - "settings": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster." - } - }, - "description": "Contains all settings for the cluster." - }, - "ErrorResponse": { - "description": "Error response that indicates the service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "TrackedResource": { - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Definition of an Azure resource." - }, - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - } - }, - "description": "The Resource definition", - "x-ms-azure-resource": true - }, - "ClusterSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Dedicated" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "maximum": 32, - "minimum": 1, - "type": "integer", - "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters particular to a cluster instance." - }, - "EHNamespaceIdListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EHNamespaceIdContainer" - }, - "description": "Result of the List Namespace IDs operation" - } - }, - "description": "The response of the List Namespace IDs operation" - }, - "EHNamespaceIdContainer": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "id parameter" - } - }, - "description": "The full ARM ID of an Event Hubs Namespace" - }, - "EHNamespaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EHNamespace" - }, - "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" - }, - "EHNamespace": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Properties of sku resource" - }, - "properties": { - "x-ms-client-flatten": true, - "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." - }, - "clusterArmId": { - "type": "string", - "description": "Cluster ARM ID of the Namespace." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "Identifier for Azure Insights metrics." - }, - "isAutoInflateEnabled": { - "type": "boolean", - "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." - }, - "maximumThroughputUnits": { - "format": "int32", - "type": "integer", - "maximum": 20, - "minimum": 0, - "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" - }, - "kafkaEnabled": { - "type": "boolean", - "description": "Value that indicates whether Kafka is enabled for eventhub namespace." - }, - "zoneRedundant": { - "type": "boolean", - "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." - }, - "identity": { - "$ref": "#/definitions/Identity", - "description": "Properties of BYOK Identity description" - }, - "encryption": { - "$ref": "#/definitions/Encryption", - "description": "Properties of BYOK Encryption description" - } - }, - "description": "Namespace properties supplied for create namespace operation." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Single Namespace item in List or Get Operation" - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Basic", - "Standard" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "tier": { - "type": "string", - "description": "The billing tier of this particular SKU.", - "enum": [ - "Basic", - "Standard" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "maximum": 20, - "minimum": 0, - "type": "integer", - "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters supplied to the create namespace operation" - }, - "IpFilterRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Accept", - "Reject" - ], - "x-ms-enum": { - "name": "IPAction", - "modelAsString": true - } - }, - "filterName": { - "type": "string", - "description": "IP Filter name" - } - }, - "description": "Properties supplied to create or update IpFilterRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get IpFilterRules operation" - }, - "IpFilterRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "Result of the List IpFilter Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "VirtualNetworkRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "virtualNetworkSubnetId": { - "type": "string", - "description": "ARM ID of Virtual Network Subnet" - } - }, - "description": "Properties supplied to create or update VirtualNetworkRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get VirtualNetworkRules operation" - }, - "VirtualNetworkRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "Result of the List VirtualNetwork Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "Subnet": { - "properties": { - "id": { - "type": "string", - "description": "Resource ID of Virtual Network Subnet" - } - }, - "description": "Properties supplied for Subnet" - }, - "NWRuleSetIpRules": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Allow" - ], - "x-ms-enum": { - "name": "NetworkRuleIPAction", - "modelAsString": true - } - } - }, - "description": "The response from the List namespace operation." - }, - "NWRuleSetVirtualNetworkRules": { - "x-ms-client-flatten": true, - "properties": { - "subnet": { - "$ref": "#/definitions/Subnet", - "description": "Subnet properties" - }, - "ignoreMissingVnetServiceEndpoint": { - "type": "boolean", - "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" - } - }, - "description": "The response from the List namespace operation." - }, - "NetworkRuleSet": { - "properties": { - "properties": { - "description": "NetworkRuleSet properties", - "x-ms-client-flatten": true, - "properties": { - "defaultAction": { - "type": "string", - "description": "Default Action for Network Rule Set", - "enum": [ - "Allow", - "Deny" - ], - "x-ms-enum": { - "name": "DefaultAction", - "modelAsString": true - } - }, - "virtualNetworkRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" - }, - "description": "List VirtualNetwork Rules" - }, - "ipRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetIpRules" - }, - "description": "List of IpRules" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of topic resource." - }, - "Identity": { - "x-ms-client-flatten": true, - "properties": { - "principalId": { - "type": "string", - "description": "ObjectId from the KeyVault" - }, - "tenantId": { - "type": "string", - "description": "TenantId from the KeyVault" - }, - "type": { - "type": "string", - "description": "Enumerates the possible value Identity type, which currently supports only 'SystemAssigned'", - "default": "SystemAssigned", - "enum": [ - "SystemAssigned" - ], - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": false - } - } - }, - "description": "Properties to configure Identity for Bring your Own Keys" - }, - "Encryption": { - "x-ms-client-flatten": true, - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/KeyVaultProperties", - "description": "Properties of KeyVault" - }, - "keySource": { - "type": "string", - "description": "Enumerates the possible value of keySource for Encryption", - "default": "Microsoft.KeyVault", - "enum": [ - "Microsoft.KeyVault" - ], - "x-ms-enum": { - "name": "keySource", - "modelAsString": false - } - } - }, - "description": "Properties to configure Encryption" - }, - "KeyVaultProperties": { - "properties": { - "keyName": { - "type": "string", - "description": "Name of the Key from KeyVault" - }, - "keyVaultUri": { - "type": "string", - "description": "Uri of KeyVault" - } - }, - "description": "Properties to configure keyVault Properties" - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "apiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "Name of the resource group within the Azure subscription." - }, - "clusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The name of the Event Hubs Cluster." - }, - "namespaceNameParameter": { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The Namespace name" - }, - "authorizationRuleNameParameter": { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The authorization rule name." - }, - "ipFilterRuleNameParameter": { - "name": "ipFilterRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The IP Filter Rule name." - }, - "virtualNetworkRuleNameParameter": { - "name": "virtualNetworkRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The Virtual Network Rule name." - }, - "skuNameParameter": { - "name": "sku", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The sku type." - }, - "skipParameter": { - "name": "$skip", - "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "maximum": 1000, - "x-ms-parameter-location": "method" - }, - "topParameter": { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N usageDetails.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceList.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceList.json index a05c321ff63a..6d370dd73983 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceList.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" }, "responses": { diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json index fc43b939227d..d35b85a52ecc 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", "resourceGroupName": "ArunMonocle" }, diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json new file mode 100644 index 000000000000..3117aeec05db --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json @@ -0,0 +1,278 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListIPFilterRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json" + } + }, + "description": "Gets a list of IP Filter rules for a Namespace.", + "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 IpFilterRule successfully returned.", + "schema": { + "$ref": "#/definitions/IpFilterRuleListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleCreate": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "The Namespace IpFilterRule." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule created", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleDelete": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json" + } + }, + "description": "Deletes an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleGet": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json" + } + }, + "description": "Gets an IpFilterRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule returned successfully.", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "IpFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Accept", + "Reject" + ], + "x-ms-enum": { + "name": "IPAction", + "modelAsString": true + } + }, + "filterName": { + "type": "string", + "description": "IP Filter name" + } + }, + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in a List or Get IpFilterRules operation" + }, + "IpFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "Result of the List IpFilter Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" + } + }, + "description": "The response from the List namespace operation." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json new file mode 100644 index 000000000000..05bbaf4fe1a8 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json @@ -0,0 +1,529 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NamespacesListBySubscription": { + "$ref": "./examples/NameSpaces/EHNameSpaceList.json" + } + }, + "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NamespaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" + } + }, + "description": "Lists the available Namespaces within a resource group.", + "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 returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NamespaceCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" + } + }, + "description": "Creates or updates a 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/EHNamespace", + "required": [ + "location" + ] + }, + "description": "Parameters for creating a namespace resource." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully created.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub 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/EHNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "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": "Eventhub 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/EHNameSpaceGet.json" + } + }, + "description": "Gets the description of the specified namespace.", + "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 returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NamespacesUpdate": { + "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" + } + }, + "description": "Creates or updates a 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/EHNamespace" + }, + "description": "Parameters for updating a namespace resource." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully updated.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "EHNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespace" + }, + "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" + }, + "EHNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Properties of sku resource" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + }, + "properties": { + "x-ms-client-flatten": true, + "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." + }, + "clusterArmId": { + "type": "string", + "description": "Cluster ARM ID of the Namespace." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics." + }, + "isAutoInflateEnabled": { + "type": "boolean", + "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." + }, + "maximumThroughputUnits": { + "format": "int32", + "type": "integer", + "maximum": 20, + "minimum": 0, + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "type": "boolean", + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + } + }, + "description": "Namespace properties supplied for create namespace operation." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Single Namespace item in List or Get Operation" + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 20, + "minimum": 0, + "type": "integer", + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "Identity": { + "x-ms-client-flatten": true, + "properties": { + "principalId": { + "type": "string", + "description": "ObjectId from the KeyVault" + }, + "tenantId": { + "type": "string", + "description": "TenantId from the KeyVault" + }, + "type": { + "type": "string", + "description": "Enumerates the possible value Identity type, which currently supports only 'SystemAssigned'", + "default": "SystemAssigned", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + } + }, + "description": "Properties to configure Identity for Bring your Own Keys" + }, + "Encryption": { + "x-ms-client-flatten": true, + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": false + } + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + } + }, + "description": "Properties to configure keyVault Properties" + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json new file mode 100644 index 000000000000..fbf741fc7b1f --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json @@ -0,0 +1,218 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "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" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "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 NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied for Subnet" + }, + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + } + } + }, + "description": "The response from the List namespace operation." + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + } + }, + "description": "The response from the List namespace operation." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + } + } + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of topic resource." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json new file mode 100644 index 000000000000..38b1a7b797f1 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json @@ -0,0 +1,126 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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": { + "/providers/Microsoft.EventHub/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "EHOperations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "description": "Lists all of the available Event Hub REST API operations.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Event Hub operations supported by the Microsoft.EventHub resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A Event Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.EventHub" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json new file mode 100644 index 000000000000..a5104a699020 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json @@ -0,0 +1,156 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { + "patch": { + "tags": [ + "Event Hubs Cluster Configuration" + ], + "operationId": "Configuration_Patch", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties", + "required": [ + "settings" + ] + }, + "description": "Parameters for creating an Event Hubs Cluster resource." + } + ], + "x-ms-examples": { + "ClustersQuotasConfigurationPatch": { + "$ref": "./examples/Clusters/ClusterQuotaConfigurationPatch.json" + } + }, + "description": "Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.", + "responses": { + "200": { + "description": "Event Hubs Cluster settings configuration returned.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "201": { + "description": "Event Hubs Cluster setting configuration request successfully accepted.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "202": { + "description": "Event Hubs Cluster update request accepted." + }, + "default": { + "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Event Hubs Cluster Configuration" + ], + "operationId": "Configuration_Get", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ClustersQuotasConfigurationGet": { + "$ref": "./examples/Clusters/ClusterQuotaConfigurationGet.json" + } + }, + "description": "Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.", + "responses": { + "200": { + "description": "Event Hubs Cluster settings configuration returned.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "default": { + "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ClusterQuotaConfigurationProperties": { + "properties": { + "settings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster." + } + }, + "description": "Contains all settings for the cluster." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json new file mode 100644 index 000000000000..4e1b10f54503 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json @@ -0,0 +1,262 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListVirtualNetworkRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json" + } + }, + "description": "Gets a list of VirtualNetwork rules for a Namespace.", + "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 VirtualNetworkRule successfully returned.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The Namespace VirtualNetworkRule." + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule created", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleDelete": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json" + } + }, + "description": "Deletes an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json" + } + }, + "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule returned successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "virtualNetworkSubnetId": { + "type": "string", + "description": "ARM ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in a List or Get VirtualNetworkRules operation" + }, + "VirtualNetworkRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "Result of the List VirtualNetwork Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" + } + }, + "description": "The response from the List namespace operation." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json new file mode 100644 index 000000000000..a9a69b03b22c --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json @@ -0,0 +1,886 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListAuthorizationRules", + "x-ms-examples": { + "ListAuthorizationRules": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json" + } + }, + "description": "Gets a list of authorization rules for a Namespace.", + "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 AuthorizationRule successfully returned.", + "schema": { + "$ref": "#/definitions/AuthorizationRuleListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an AuthorizationRule for a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationRule" + }, + "description": "The shared access AuthorizationRule." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule created", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleDelete": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json" + } + }, + "description": "Deletes an AuthorizationRule for a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json" + } + }, + "description": "Gets an AuthorizationRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule returned successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings returned successfully.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_RegenerateKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleRegenerateKey": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings for the specified Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters required to regenerate the connection string." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings regenerated successfully.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", + "x-ms-examples": { + "ListAuthorizationRules": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json" + } + }, + "description": "Gets a list of authorization rules for a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule successfully returned.", + "schema": { + "$ref": "#/definitions/AuthorizationRuleListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json" + } + }, + "description": "Gets an AuthorizationRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias Namespace AuthorizationRule returned successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings returned successfully.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules": { + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_ListAuthorizationRules", + "x-ms-examples": { + "EventHubAuthorizationRuleListAll": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for an Event Hub.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule returned successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationRuleListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "EventHubAuthorizationRuleCreate": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationRule" + }, + "description": "The shared access AuthorizationRule." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule successfully created.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_GetAuthorizationRule", + "x-ms-examples": { + "EventHubAuthorizationRuleGet": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleGet.json" + } + }, + "description": "Gets an AuthorizationRule for an Event Hub by rule name.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule successfully returned.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_DeleteAuthorizationRule", + "x-ms-examples": { + "EventHubAuthorizationRuleDelete": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleDelete.json" + } + }, + "description": "Deletes an Event Hub AuthorizationRule.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_ListKeys", + "x-ms-examples": { + "EventHubAuthorizationRuleListKey": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleListKey.json" + } + }, + "description": "Gets the ACS and SAS connection strings for the Event Hub.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_RegenerateKeys", + "x-ms-examples": { + "EventHubAuthorizationRuleRegenerateKey": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the ACS and SAS connection strings for the Event Hub.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey)." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules" + } + }, + "description": "The response from the List namespace operation." + }, + "AuthorizationRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": true + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "Properties supplied to create or update AuthorizationRule" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in a List or Get AuthorizationRule operation" + }, + "AccessKeys": { + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace AuthorizationRule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace AuthorizationRule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the AuthorizationRule." + } + }, + "description": "Namespace/EventHub Connection String" + }, + "RegenerateAccessKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json new file mode 100644 index 000000000000..3dbed5304f40 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json @@ -0,0 +1,132 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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.EventHub/checkNameAvailability": { + "post": { + "tags": [ + "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/v1/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": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json deleted file mode 100644 index ff360bf3d626..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json +++ /dev/null @@ -1,3045 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubManagementClient", - "description": "Azure Event Hubs 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": { - "/providers/Microsoft.EventHub/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "x-ms-examples": { - "EHOperations_List": { - "$ref": "./examples/EHOperations_List.json" - } - }, - "description": "Lists all of the available Event Hub REST API operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/CheckNameAvailability": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CheckNameAvailability", - "x-ms-examples": { - "NamespacesCheckNameAvailability": { - "$ref": "./examples/NameSpaces/EHNameSpaceCheckNameAvailability.json" - } - }, - "description": "Check the give Namespace name availability.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/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": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_List", - "x-ms-examples": { - "NamespacesListBySubscription": { - "$ref": "./examples/NameSpaces/EHNameSpaceList.json" - } - }, - "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListByResourceGroup", - "x-ms-examples": { - "NamespaceListByResourceGroup": { - "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" - } - }, - "description": "Lists the available Namespaces within a resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdate", - "x-ms-examples": { - "NamespaceCreate": { - "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace", - "required": [ - "location" - ] - }, - "description": "Parameters for creating a namespace resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace create request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "200": { - "description": "Namespace successfully created.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Delete", - "x-ms-examples": { - "NameSpaceDelete": { - "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" - } - }, - "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace successfully deleted." - }, - "202": { - "description": "Namespace delete request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Get", - "x-ms-examples": { - "NameSpaceGet": { - "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" - } - }, - "description": "Gets the description of the specified namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Update", - "x-ms-examples": { - "NamespacesUpdate": { - "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace" - }, - "description": "Parameters for updating a namespace resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "200": { - "description": "Namespace successfully updated.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/messagingplan": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetMessagingPlan", - "x-ms-examples": { - "GetNamespaceMessagingPlan": { - "$ref": "./examples/NameSpaces/EHNameSpaceGetMessagingPlan.json" - } - }, - "description": "Gets messaging plan for specified namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Messaging Plan successfully returned.", - "schema": { - "$ref": "#/definitions/MessagingPlan" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListAuthorizationRules", - "x-ms-examples": { - "ListAuthorizationRules": { - "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json" - } - }, - "description": "Gets a list of authorization rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace AuthorizationRule successfully returned.", - "schema": { - "$ref": "#/definitions/AuthorizationRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", - "x-ms-examples": { - "NameSpaceAuthorizationRuleCreate": { - "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleCreate.json" - } - }, - "description": "Creates or updates an AuthorizationRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AuthorizationRule" - }, - "description": "The shared access AuthorizationRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace AuthorizationRule created", - "schema": { - "$ref": "#/definitions/AuthorizationRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteAuthorizationRule", - "x-ms-examples": { - "NameSpaceAuthorizationRuleDelete": { - "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json" - } - }, - "description": "Deletes an AuthorizationRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace AuthorizationRule successfully deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetAuthorizationRule", - "x-ms-examples": { - "NameSpaceAuthorizationRuleGet": { - "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json" - } - }, - "description": "Gets an AuthorizationRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace AuthorizationRule returned successfully.", - "schema": { - "$ref": "#/definitions/AuthorizationRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListKeys", - "x-ms-examples": { - "NameSpaceAuthorizationRuleListKey": { - "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleListKey.json" - } - }, - "description": "Gets the primary and secondary connection strings for the Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings returned successfully.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_RegenerateKeys", - "x-ms-examples": { - "NameSpaceAuthorizationRuleRegenerateKey": { - "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json" - } - }, - "description": "Regenerates the primary or secondary connection strings for the specified Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateAccessKeyParameters" - }, - "description": "Parameters required to regenerate the connection string." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings regenerated successfully.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", - "x-ms-examples": { - "NamespacesCheckNameAvailability": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasCheckNameAvailability.json" - } - }, - "description": "Check the give Namespace name availability.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityParameter" - }, - "description": "Parameters to check availability of the given Alias name" - } - ], - "responses": { - "200": { - "description": "check availability returned successfully.", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs": { - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_List", - "x-ms-examples": { - "EHAliasList": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasList.json" - } - }, - "description": "Gets all Alias(Disaster Recovery configurations)", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for eventhub namespace", - "schema": { - "$ref": "#/definitions/ArmDisasterRecoveryListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { - "put": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", - "x-ms-examples": { - "EHAliasCreate": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasCreate.json" - } - }, - "description": "Creates or updates a new Alias(Disaster Recovery configuration)", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ArmDisasterRecovery" - }, - "description": "Parameters required to create an Alias(Disaster Recovery configuration)" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Alias(Disaster Recovery configuration) successfully created", - "schema": { - "$ref": "#/definitions/ArmDisasterRecovery" - } - }, - "201": { - "description": "Alias(Disaster Recovery configuration) creation request received" - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_Delete", - "x-ms-examples": { - "EHAliasDelete": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasDelete.json" - } - }, - "description": "Deletes an Alias(Disaster Recovery configuration)", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Delete Alias(Disaster Recovery configuration) request accepted" - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_Get", - "x-ms-examples": { - "EHAliasGet": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasGet.json" - } - }, - "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", - "schema": { - "$ref": "#/definitions/ArmDisasterRecovery" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_BreakPairing", - "x-ms-examples": { - "EHAliasBreakPairing": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasBreakPairing.json" - } - }, - "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Break-Pairing operation is successful." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_FailOver", - "x-ms-examples": { - "EHAliasFailOver": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasFailOver.json" - } - }, - "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Failover operation is successful." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules": { - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", - "x-ms-examples": { - "ListAuthorizationRules": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json" - } - }, - "description": "Gets a list of authorization rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace AuthorizationRule successfully returned.", - "schema": { - "$ref": "#/definitions/AuthorizationRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules/{authorizationRuleName}": { - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", - "x-ms-examples": { - "NameSpaceAuthorizationRuleGet": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json" - } - }, - "description": "Gets an AuthorizationRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Alias Namespace AuthorizationRule returned successfully.", - "schema": { - "$ref": "#/definitions/AuthorizationRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules/{authorizationRuleName}/listKeys": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_ListKeys", - "x-ms-examples": { - "NameSpaceAuthorizationRuleListKey": { - "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListKey.json" - } - }, - "description": "Gets the primary and secondary connection strings for the Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings returned successfully.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs": { - "get": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_ListByNamespace", - "x-ms-examples": { - "EventHubsListAll": { - "$ref": "./examples/EventHubs/EHEventHubListByNameSpace.json" - } - }, - "description": "Gets all the Event Hubs in a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkipParameter" - }, - { - "$ref": "#/parameters/TopParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of Event Hubs.", - "schema": { - "$ref": "#/definitions/EventHubListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}": { - "put": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_CreateOrUpdate", - "x-ms-examples": { - "EventHubCreate": { - "$ref": "./examples/EventHubs/EHEventHubCreate.json" - } - }, - "description": "Creates or updates a new Event Hub as a nested resource within a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Eventhub" - }, - "description": "Parameters supplied to create an Event Hub resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Event Hub successfully created.", - "schema": { - "$ref": "#/definitions/Eventhub" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_Delete", - "x-ms-examples": { - "EventHubDelete": { - "$ref": "./examples/EventHubs/EHEventHubDelete.json" - } - }, - "description": "Deletes an Event Hub from the specified Namespace and resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Event Hub successfully deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_Get", - "x-ms-examples": { - "EventHubGet": { - "$ref": "./examples/EventHubs/EHEventHubGet.json" - } - }, - "description": "Gets an Event Hubs description for the specified Event Hub.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the Event Hub description.", - "schema": { - "$ref": "#/definitions/Eventhub" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules": { - "get": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_ListAuthorizationRules", - "x-ms-examples": { - "EventHubAuthorizationRuleListAll": { - "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleListAll.json" - } - }, - "description": "Gets the authorization rules for an Event Hub.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Event Hub AuthorizationRule returned successfully.", - "schema": { - "$ref": "#/definitions/AuthorizationRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}": { - "put": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_CreateOrUpdateAuthorizationRule", - "x-ms-examples": { - "EventHubAuthorizationRuleCreate": { - "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleCreate.json" - } - }, - "description": "Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AuthorizationRule" - }, - "description": "The shared access AuthorizationRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Event Hub AuthorizationRule successfully created.", - "schema": { - "$ref": "#/definitions/AuthorizationRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_GetAuthorizationRule", - "x-ms-examples": { - "EventHubAuthorizationRuleGet": { - "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleGet.json" - } - }, - "description": "Gets an AuthorizationRule for an Event Hub by rule name.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Event Hub AuthorizationRule successfully returned.", - "schema": { - "$ref": "#/definitions/AuthorizationRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_DeleteAuthorizationRule", - "x-ms-examples": { - "EventHubAuthorizationRuleDelete": { - "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleDelete.json" - } - }, - "description": "Deletes an Event Hub AuthorizationRule.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Event Hub AuthorizationRule successfully deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/ListKeys": { - "post": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_ListKeys", - "x-ms-examples": { - "EventHubAuthorizationRuleListKey": { - "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleListKey.json" - } - }, - "description": "Gets the ACS and SAS connection strings for the Event Hub.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully returned.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { - "post": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_RegenerateKeys", - "x-ms-examples": { - "EventHubAuthorizationRuleRegenerateKey": { - "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json" - } - }, - "description": "Regenerates the ACS and SAS connection strings for the Event Hub.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateAccessKeyParameters" - }, - "description": "Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey)." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully regenerated.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}": { - "put": { - "tags": [ - "ConsumerGroups" - ], - "operationId": "ConsumerGroups_CreateOrUpdate", - "x-ms-examples": { - "ConsumerGroupCreate": { - "$ref": "./examples/ConsumerGroup/EHConsumerGroupCreate.json" - } - }, - "description": "Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/ConsumerGroupNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConsumerGroup" - }, - "description": "Parameters supplied to create or update a consumer group resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Consumer group successfully created.", - "schema": { - "$ref": "#/definitions/ConsumerGroup" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ConsumerGroups" - ], - "operationId": "ConsumerGroups_Delete", - "x-ms-examples": { - "ConsumerGroupDelete": { - "$ref": "./examples/ConsumerGroup/EHConsumerGroupDelete.json" - } - }, - "description": "Deletes a consumer group from the specified Event Hub and resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/ConsumerGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Consumer group deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ConsumerGroups" - ], - "operationId": "ConsumerGroups_Get", - "x-ms-examples": { - "ConsumerGroupGet": { - "$ref": "./examples/ConsumerGroup/EHConsumerGroupGet.json" - } - }, - "description": "Gets a description for the specified consumer group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/ConsumerGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the consumer group description.", - "schema": { - "$ref": "#/definitions/ConsumerGroup" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups": { - "get": { - "tags": [ - "ConsumerGroups" - ], - "operationId": "ConsumerGroups_ListByEventHub", - "x-ms-examples": { - "ConsumerGroupsListAll": { - "$ref": "./examples/ConsumerGroup/EHConsumerGroupListByEventHub.json" - } - }, - "description": "Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/EventHubNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkipParameter" - }, - { - "$ref": "#/parameters/TopParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of consumer groups.", - "schema": { - "$ref": "#/definitions/ConsumerGroupListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/sku/{sku}/regions": { - "get": { - "tags": [ - "Regions" - ], - "operationId": "Regions_ListBySku", - "x-ms-examples": { - "RegionsListBySkuBasic": { - "$ref": "./examples/EHRegionsListBySkuBasic.json" - }, - "RegionsListBySkuStandard": { - "$ref": "./examples/EHRegionsListBySkuStandard.json" - } - }, - "description": "Gets the available Regions for a given sku", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkuNameParameter" - } - ], - "responses": { - "200": { - "description": "Regions successfully returned.", - "schema": { - "$ref": "#/definitions/MessagingRegionsListResult" - } - }, - "default": { - "description": "EventHub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default": { - "put": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json" - } - }, - "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", - "description": "Create or update NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - }, - "description": "The Namespace IpFilterRule." - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "EventHub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json" - } - }, - "operationId": "Namespaces_GetNetworkRuleSet", - "description": "Gets NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "EventHub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets": { - "get": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetList": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetList.json" - } - }, - "operationId": "Namespaces_ListNetworkRuleSets", - "description": "Gets list of NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "List of NetworkRuleSets for Namespace successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSetListResult" - } - }, - "default": { - "description": "EventHub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "TrackedResource": { - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Definition of Resource" - }, - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - } - }, - "description": "The Resource definition", - "x-ms-azure-resource": true - }, - "EHNamespaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EHNamespace" - }, - "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" - }, - "EHNamespace": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Properties of sku resource" - }, - "properties": { - "x-ms-client-flatten": true, - "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." - }, - "isAutoInflateEnabled": { - "type": "boolean", - "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." - }, - "maximumThroughputUnits": { - "format": "int32", - "type": "integer", - "maximum": 20, - "minimum": 0, - "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" - }, - "kafkaEnabled": { - "type": "boolean", - "description": "Value that indicates whether Kafka is enabled for eventhub namespace." - } - }, - "description": "Namespace properties supplied for create namespace operation." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Single Namespace item in List or Get Operation" - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Basic", - "Standard" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "tier": { - "type": "string", - "description": "The billing tier of this particular SKU.", - "enum": [ - "Basic", - "Standard" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "maximum": 20, - "minimum": 0, - "type": "integer", - "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters supplied to the create namespace operation" - }, - "AuthorizationRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AuthorizationRule" - }, - "description": "Result of the List Authorization Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "AuthorizationRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "rights": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Manage", - "Send", - "Listen" - ], - "x-ms-enum": { - "name": "AccessRights", - "modelAsString": true - } - }, - "description": "The rights associated with the rule." - } - }, - "required": [ - "rights" - ], - "description": "Properties supplied to create or update AuthorizationRule" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get AuthorizationRule operation" - }, - "AccessKeys": { - "properties": { - "primaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Primary connection string of the created namespace AuthorizationRule." - }, - "secondaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Secondary connection string of the created namespace AuthorizationRule." - }, - "aliasPrimaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Primary connection string of the alias if GEO DR is enabled" - }, - "aliasSecondaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Secondary connection string of the alias if GEO DR is enabled" - }, - "primaryKey": { - "readOnly": true, - "type": "string", - "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." - }, - "secondaryKey": { - "readOnly": true, - "type": "string", - "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." - }, - "keyName": { - "readOnly": true, - "type": "string", - "description": "A string that describes the AuthorizationRule." - } - }, - "description": "Namespace/EventHub Connection String" - }, - "RegenerateAccessKeyParameters": { - "properties": { - "keyType": { - "type": "string", - "description": "The access key to regenerate.", - "enum": [ - "PrimaryKey", - "SecondaryKey" - ], - "x-ms-enum": { - "name": "KeyType", - "modelAsString": false - } - }, - "key": { - "type": "string", - "description": "Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType" - } - }, - "required": [ - "keyType" - ], - "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." - }, - "Eventhub": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "partitionIds": { - "readOnly": true, - "type": "array", - "items": { - "type": "string" - }, - "description": "Current number of shards on the Event Hub." - }, - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Exact time the Event Hub was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The exact time the message was updated." - }, - "messageRetentionInDays": { - "format": "int64", - "type": "integer", - "minimum": 1, - "description": "Number of days to retain the events for this Event Hub, value should be 1 to 7 days" - }, - "partitionCount": { - "format": "int64", - "type": "integer", - "minimum": 1, - "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." - }, - "status": { - "type": "string", - "description": "Enumerates the possible values for the status of the Event Hub.", - "enum": [ - "Active", - "Disabled", - "Restoring", - "SendDisabled", - "ReceiveDisabled", - "Creating", - "Deleting", - "Renaming", - "Unknown" - ], - "x-ms-enum": { - "name": "EntityStatus", - "modelAsString": false - } - }, - "captureDescription": { - "$ref": "#/definitions/CaptureDescription", - "description": "Properties of capture description" - } - }, - "description": "Properties supplied to the Create Or Update Event Hub operation." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in List or Get Event Hub operation" - }, - "CaptureDescription": { - "properties": { - "enabled": { - "type": "boolean", - "description": "A value that indicates whether capture description is enabled. " - }, - "encoding": { - "type": "string", - "description": "Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version", - "enum": [ - "Avro", - "AvroDeflate" - ], - "x-ms-enum": { - "name": "EncodingCaptureDescription", - "modelAsString": false - } - }, - "intervalInSeconds": { - "format": "int32", - "type": "integer", - "maximum": 900, - "minimum": 60, - "description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" - }, - "sizeLimitInBytes": { - "format": "int32", - "type": "integer", - "maximum": 524288000, - "minimum": 10485760, - "description": "The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes" - }, - "destination": { - "$ref": "#/definitions/Destination", - "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" - }, - "skipEmptyArchives": { - "type": "boolean", - "description": "A value that indicates whether to Skip Empty Archives" - } - }, - "description": "Properties to configure capture description for eventhub" - }, - "Destination": { - "properties": { - "name": { - "type": "string", - "description": "Name for capture destination" - }, - "properties": { - "x-ms-client-flatten": true, - "properties": { - "storageAccountResourceId": { - "type": "string", - "description": "Resource id of the storage account to be used to create the blobs" - }, - "blobContainer": { - "type": "string", - "description": "Blob container Name" - }, - "archiveNameFormat": { - "type": "string", - "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" - } - }, - "description": "Properties describing the storage account, blob container and archive name format for capture destination" - } - }, - "description": "Capture storage details for capture description" - }, - "EventHubListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Eventhub" - }, - "description": "Result of the List EventHubs operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of EventHubs." - } - }, - "description": "The result of the List EventHubs operation." - }, - "ConsumerGroup": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Exact time the message was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The exact time the message was updated." - }, - "userMetadata": { - "type": "string", - "description": "User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." - } - }, - "description": "Single item in List or Get Consumer group operation" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in List or Get Consumer group operation" - }, - "ConsumerGroupListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ConsumerGroup" - }, - "description": "Result of the List Consumer Group operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Consumer Group" - } - }, - "description": "The result to the List Consumer Group operation." - }, - "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" - }, - "OperationListResult": { - "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "description": "List of Event Hub operations supported by the Microsoft.EventHub resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "A Event Hub REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{operation}" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "Service provider: Microsoft.EventHub" - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "Resource on which the operation is performed: Invoice, etc." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "Operation type: Read, write, delete, etc." - } - } - } - } - }, - "ErrorResponse": { - "description": "Error response indicates EventHub service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "ArmDisasterRecovery": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", - "enum": [ - "Accepted", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStateDR", - "modelAsString": false - } - }, - "partnerNamespace": { - "type": "string", - "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" - }, - "alternateName": { - "type": "string", - "description": "Alternate name specified when alias and namespace names are same." - }, - "role": { - "readOnly": true, - "type": "string", - "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", - "enum": [ - "Primary", - "PrimaryNotReplicating", - "Secondary" - ], - "x-ms-enum": { - "name": "RoleDisasterRecovery", - "modelAsString": false - } - }, - "pendingReplicationOperationsCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of entities pending to be replicated." - } - }, - "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" - }, - "ArmDisasterRecoveryListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ArmDisasterRecovery" - }, - "description": "List of Alias(Disaster Recovery configurations)" - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" - } - }, - "description": "The result of the List Alias(Disaster Recovery configuration) operation." - }, - "MessagingRegions": { - "properties": { - "properties": { - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "Region code" - }, - "fullName": { - "readOnly": true, - "type": "string", - "description": "Full name of the region" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Messaging Region" - }, - "MessagingRegionsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MessagingRegions" - }, - "description": "Result of the List MessagingRegions type." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next set of results. Not empty if Value contains incomplete list of MessagingRegions." - } - }, - "description": "The response of the List MessagingRegions operation." - }, - "MessagingPlan": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "sku": { - "format": "int32", - "readOnly": true, - "type": "integer", - "description": "Sku type" - }, - "selectedEventHubUnit": { - "format": "int32", - "readOnly": true, - "type": "integer", - "description": "Selected event hub unit" - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The exact time the messaging plan was updated." - }, - "revision": { - "format": "int64", - "readOnly": true, - "type": "integer", - "description": "revision number" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Messaging Plan for the namespace" - }, - "Subnet": { - "properties": { - "id": { - "type": "string", - "description": "Resource ID of Virtual Network Subnet" - } - }, - "required": [ - "id" - ], - "description": "Properties supplied for Subnet" - }, - "NWRuleSetIpRules": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Allow" - ], - "x-ms-enum": { - "name": "NetworkRuleIPAction", - "modelAsString": true - }, - "default": "Allow" - } - }, - "description": "Description of NetWorkRuleSet - IpRules resource." - }, - "NWRuleSetVirtualNetworkRules": { - "x-ms-client-flatten": true, - "properties": { - "subnet": { - "$ref": "#/definitions/Subnet", - "description": "Subnet properties" - }, - "ignoreMissingVnetServiceEndpoint": { - "type": "boolean", - "description": "Value that indicates whether to ignore missing VNet Service Endpoint" - } - }, - "description": "Description of VirtualNetworkRules - NetworkRules resource." - }, - "NetworkRuleSet": { - "properties": { - "properties": { - "description": "NetworkRuleSet properties", - "x-ms-client-flatten": true, - "properties": { - "defaultAction": { - "type": "string", - "description": "Default Action for Network Rule Set", - "enum": [ - "Allow", - "Deny" - ], - "x-ms-enum": { - "name": "DefaultAction", - "modelAsString": true - } - }, - "virtualNetworkRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" - }, - "description": "List VirtualNetwork Rules" - }, - "ipRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetIpRules" - }, - "description": "List of IpRules" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of NetworkRuleSet resource." - }, - "NetworkRuleSetListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkRuleSet" - }, - "description": "Result of the List NetworkRuleSet operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet." - } - }, - "description": "The response of the List NetworkRuleSet operation" - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API Version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "Name of the resource group within the azure subscription." - }, - "NamespaceNameParameter": { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The Namespace name" - }, - "AuthorizationRuleNameParameter": { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The authorization rule name." - }, - "EventHubNameParameter": { - "name": "eventHubName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The Event Hub name" - }, - "AliasNameParameter": { - "name": "alias", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The Disaster Recovery configuration name" - }, - "ConsumerGroupNameParameter": { - "name": "consumerGroupName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The consumer group name" - }, - "SkuNameParameter": { - "name": "sku", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The sku type." - }, - "SkipParameter": { - "name": "$skip", - "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "maximum": 1000, - "x-ms-parameter-location": "method" - }, - "TopParameter": { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N usageDetails.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json new file mode 100644 index 000000000000..3f9cf49a0dec --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json @@ -0,0 +1,292 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}": { + "put": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_CreateOrUpdate", + "x-ms-examples": { + "ConsumerGroupCreate": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupCreate.json" + } + }, + "description": "Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConsumerGroup" + }, + "description": "Parameters supplied to create or update a consumer group resource." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Consumer group successfully created.", + "schema": { + "$ref": "#/definitions/ConsumerGroup" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_Delete", + "x-ms-examples": { + "ConsumerGroupDelete": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupDelete.json" + } + }, + "description": "Deletes a consumer group from the specified Event Hub and resource group.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Consumer group deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_Get", + "x-ms-examples": { + "ConsumerGroupGet": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupGet.json" + } + }, + "description": "Gets a description for the specified consumer group.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the consumer group description.", + "schema": { + "$ref": "#/definitions/ConsumerGroup" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups": { + "get": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_ListByEventHub", + "x-ms-examples": { + "ConsumerGroupsListAll": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupListByEventHub.json" + } + }, + "description": "Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of consumer groups.", + "schema": { + "$ref": "#/definitions/ConsumerGroupListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ConsumerGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "userMetadata": { + "type": "string", + "description": "User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." + } + }, + "description": "Single item in List or Get Consumer group operation" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Consumer group operation" + }, + "ConsumerGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConsumerGroup" + }, + "description": "Result of the List Consumer Group operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Consumer Group" + } + }, + "description": "The result to the List Consumer Group operation." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json new file mode 100644 index 000000000000..c9ab9ef1e42a --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json @@ -0,0 +1,482 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/checkNameAvailability": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", + "x-ms-examples": { + "NamespacesCheckNameAvailability": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasCheckNameAvailability.json" + } + }, + "description": "Check the give Namespace name availability.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameter" + }, + "description": "Parameters to check availability of the given Alias 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/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_List", + "x-ms-examples": { + "EHAliasList": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasList.json" + } + }, + "description": "Gets all Alias(Disaster Recovery configurations)", + "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": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for eventhub namespace", + "schema": { + "$ref": "#/definitions/ArmDisasterRecoveryListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { + "put": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", + "x-ms-examples": { + "EHAliasCreate": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasCreate.json" + } + }, + "description": "Creates or updates a new Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias(Disaster Recovery configuration) successfully created", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "201": { + "description": "Alias(Disaster Recovery configuration) creation request received" + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Delete", + "x-ms-examples": { + "EHAliasDelete": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasDelete.json" + } + }, + "description": "Deletes an Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Alias(Disaster Recovery configuration) request accepted" + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Get", + "x-ms-examples": { + "EHAliasGet": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasGet.json" + } + }, + "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_BreakPairing", + "x-ms-examples": { + "EHAliasBreakPairing": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasBreakPairing.json" + } + }, + "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Break-Pairing operation is successful." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_FailOver", + "x-ms-examples": { + "EHAliasFailOver": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasFailOver.json" + } + }, + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Failover operation is successful." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/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" + }, + "ArmDisasterRecovery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", + "enum": [ + "Accepted", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStateDR", + "modelAsString": false + } + }, + "partnerNamespace": { + "type": "string", + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "alternateName": { + "type": "string", + "description": "Alternate name specified when alias and namespace names are same." + }, + "role": { + "readOnly": true, + "type": "string", + "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", + "enum": [ + "Primary", + "PrimaryNotReplicating", + "Secondary" + ], + "x-ms-enum": { + "name": "RoleDisasterRecovery", + "modelAsString": false + } + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + } + }, + "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" + }, + "ArmDisasterRecoveryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "List of Alias(Disaster Recovery configurations)" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" + } + }, + "description": "The result of the List Alias(Disaster Recovery configuration) operation." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json new file mode 100644 index 000000000000..7018d4b01cf6 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json @@ -0,0 +1,389 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs": { + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_ListByNamespace", + "x-ms-examples": { + "EventHubsListAll": { + "$ref": "./examples/EventHubs/EHEventHubListByNameSpace.json" + } + }, + "description": "Gets all the Event Hubs in a Namespace.", + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Event Hubs.", + "schema": { + "$ref": "#/definitions/EventHubListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}": { + "put": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_CreateOrUpdate", + "x-ms-examples": { + "EventHubCreate": { + "$ref": "./examples/EventHubs/EHEventHubCreate.json" + } + }, + "description": "Creates or updates a new Event Hub as a nested resource within a Namespace.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Eventhub" + }, + "description": "Parameters supplied to create an Event Hub resource." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub successfully created.", + "schema": { + "$ref": "#/definitions/Eventhub" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_Delete", + "x-ms-examples": { + "EventHubDelete": { + "$ref": "./examples/EventHubs/EHEventHubDelete.json" + } + }, + "description": "Deletes an Event Hub from the specified Namespace and resource group.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_Get", + "x-ms-examples": { + "EventHubGet": { + "$ref": "./examples/EventHubs/EHEventHubGet.json" + } + }, + "description": "Gets an Event Hubs description for the specified Event Hub.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Event Hub description.", + "schema": { + "$ref": "#/definitions/Eventhub" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CaptureDescription": { + "properties": { + "enabled": { + "type": "boolean", + "description": "A value that indicates whether capture description is enabled. " + }, + "encoding": { + "type": "string", + "description": "Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version", + "enum": [ + "Avro", + "AvroDeflate" + ], + "x-ms-enum": { + "name": "EncodingCaptureDescription", + "modelAsString": false + } + }, + "intervalInSeconds": { + "format": "int32", + "type": "integer", + "maximum": 900, + "minimum": 60, + "description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" + }, + "sizeLimitInBytes": { + "format": "int32", + "type": "integer", + "maximum": 524288000, + "minimum": 10485760, + "description": "The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes" + }, + "destination": { + "$ref": "#/definitions/Destination", + "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" + }, + "skipEmptyArchives": { + "type": "boolean", + "description": "A value that indicates whether to Skip Empty Archives" + } + }, + "description": "Properties to configure capture description for eventhub" + }, + "Eventhub": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "partitionIds": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Current number of shards on the Event Hub." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the Event Hub was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "messageRetentionInDays": { + "format": "int64", + "type": "integer", + "minimum": 1, + "description": "Number of days to retain the events for this Event Hub, value should be 1 to 7 days" + }, + "partitionCount": { + "format": "int64", + "type": "integer", + "minimum": 1, + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." + }, + "status": { + "type": "string", + "description": "Enumerates the possible values for the status of the Event Hub.", + "enum": [ + "Active", + "Disabled", + "Restoring", + "SendDisabled", + "ReceiveDisabled", + "Creating", + "Deleting", + "Renaming", + "Unknown" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": false + } + }, + "captureDescription": { + "$ref": "#/definitions/CaptureDescription", + "description": "Properties of capture description" + } + }, + "description": "Properties supplied to the Create Or Update Event Hub operation." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Event Hub operation" + }, + "EventHubListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Eventhub" + }, + "description": "Result of the List EventHubs operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of EventHubs." + } + }, + "description": "The result of the List EventHubs operation." + }, + "Destination": { + "properties": { + "name": { + "type": "string", + "description": "Name for capture destination" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Resource id of the storage account to be used to create the blobs" + }, + "blobContainer": { + "type": "string", + "description": "Blob container Name" + }, + "archiveNameFormat": { + "type": "string", + "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" + } + }, + "description": "Properties describing the storage account, blob container and archive name format for capture destination" + } + }, + "description": "Capture storage details for capture description" + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json new file mode 100644 index 000000000000..83abb842fa9f --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json @@ -0,0 +1,533 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NamespacesListBySubscription": { + "$ref": "./examples/NameSpaces/EHNameSpaceList.json" + } + }, + "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NamespaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" + } + }, + "description": "Lists the available Namespaces within a resource group.", + "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 returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub 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.EventHub/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NamespaceCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" + } + }, + "description": "Creates or updates a 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/EHNamespace", + "required": [ + "location" + ] + }, + "description": "Parameters for creating a namespace resource." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully created.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub 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/EHNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "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": "Eventhub 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/EHNameSpaceGet.json" + } + }, + "description": "Gets the description of the specified namespace.", + "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 returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NamespacesUpdate": { + "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" + } + }, + "description": "Creates or updates a 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/EHNamespace" + }, + "description": "Parameters for updating a namespace resource." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully updated.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/messagingplan": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetMessagingPlan", + "x-ms-examples": { + "GetNamespaceMessagingPlan": { + "$ref": "./examples/NameSpaces/EHNameSpaceGetMessagingPlan.json" + } + }, + "description": "Gets messaging plan for specified namespace.", + "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": "Messaging Plan successfully returned.", + "schema": { + "$ref": "#/definitions/MessagingPlan" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 20, + "minimum": 0, + "type": "integer", + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "EHNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespace" + }, + "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" + }, + "EHNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Properties of sku resource" + }, + "properties": { + "x-ms-client-flatten": true, + "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." + }, + "isAutoInflateEnabled": { + "type": "boolean", + "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." + }, + "maximumThroughputUnits": { + "format": "int32", + "type": "integer", + "maximum": 20, + "minimum": 0, + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "type": "boolean", + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." + } + }, + "description": "Namespace properties supplied for create namespace operation." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Single Namespace item in List or Get Operation" + }, + "MessagingPlan": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "sku": { + "format": "int32", + "readOnly": true, + "type": "integer", + "description": "Sku type" + }, + "selectedEventHubUnit": { + "format": "int32", + "readOnly": true, + "type": "integer", + "description": "Selected event hub unit" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The exact time the messaging plan was updated." + }, + "revision": { + "format": "int64", + "readOnly": true, + "type": "integer", + "description": "revision number" + } + } + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Messaging Plan for the namespace" + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json new file mode 100644 index 000000000000..d32c36ffc602 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json @@ -0,0 +1,283 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "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" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "EventHub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "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 NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "EventHub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetList": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetList.json" + } + }, + "operationId": "Namespaces_ListNetworkRuleSets", + "description": "Gets list of NetworkRuleSet for a Namespace.", + "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": "List of NetworkRuleSets for Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSetListResult" + } + }, + "default": { + "description": "EventHub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "required": [ + "id" + ], + "description": "Properties supplied for Subnet" + }, + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + }, + "default": "Allow" + } + }, + "description": "Description of NetWorkRuleSet - IpRules resource." + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" + } + }, + "description": "Description of VirtualNetworkRules - NetworkRules resource." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + } + } + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of NetworkRuleSet resource." + }, + "NetworkRuleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "Result of the List NetworkRuleSet operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet." + } + }, + "description": "The response of the List NetworkRuleSet operation" + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json new file mode 100644 index 000000000000..967a75365837 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json @@ -0,0 +1,126 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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": { + "/providers/Microsoft.EventHub/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "EHOperations_List": { + "$ref": "./examples/EHOperations_List.json" + } + }, + "description": "Lists all of the available Event Hub REST API operations.", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Event Hub operations supported by the Microsoft.EventHub resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A Event Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.EventHub" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json new file mode 100644 index 000000000000..1d69a375178a --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json @@ -0,0 +1,128 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs 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.EventHub/sku/{sku}/regions": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Regions_ListBySku", + "x-ms-examples": { + "RegionsListBySkuBasic": { + "$ref": "./examples/EHRegionsListBySkuBasic.json" + }, + "RegionsListBySkuStandard": { + "$ref": "./examples/EHRegionsListBySkuStandard.json" + } + }, + "description": "Gets the available Regions for a given sku", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SkuNameParameter" + } + ], + "responses": { + "200": { + "description": "Regions successfully returned.", + "schema": { + "$ref": "#/definitions/MessagingRegionsListResult" + } + }, + "default": { + "description": "EventHub error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "MessagingRegions": { + "properties": { + "properties": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "Region code" + }, + "fullName": { + "readOnly": true, + "type": "string", + "description": "Full name of the region" + } + }, + "description": "Properties of Messaging Region" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Messaging Region" + }, + "MessagingRegionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MessagingRegions" + }, + "description": "Result of the List MessagingRegions type." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of MessagingRegions." + } + }, + "description": "The response of the List MessagingRegions operation." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index 79f815441b8b..083389aa1712 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the EventHub API. ``` yaml openapi-type: arm -tag: package-2017-04 +tag: package-2018-01-preview ``` @@ -36,7 +36,15 @@ These settings apply only when `--tag=package-2017-04` is specified on the comma ``` yaml $(tag) == 'package-2017-04' input-file: -- Microsoft.EventHub/stable/2017-04-01/EventHub.json +- Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json +- Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json +- Microsoft.EventHub/stable/2017-04-01/consumergroups.json +- Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json +- Microsoft.EventHub/stable/2017-04-01/eventhubs.json +- Microsoft.EventHub/stable/2017-04-01/namespaces.json +- Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json +- Microsoft.EventHub/stable/2017-04-01/operations.json +- Microsoft.EventHub/stable/2017-04-01/sku.json ``` @@ -66,7 +74,20 @@ These settings apply only when `--tag=package-2018-01-preview` is specified on t ``` yaml $(tag) == 'package-2018-01-preview' input-file: -- Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json +- Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json +- Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json +- Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json +- Microsoft.EventHub/stable/2017-04-01/consumergroups.json +- Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json +- Microsoft.EventHub/stable/2017-04-01/eventhubs.json +- Microsoft.EventHub/stable/2017-04-01/sku.json ``` @@ -133,10 +154,22 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/EventHub.json - $(this-folder)/Microsoft.EventHub/stable/2015-08-01/EventHub.json - $(this-folder)/Microsoft.EventHub/stable/2014-09-01/EventHub.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json + - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json + - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json + - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/consumergroups.json + - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json + - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/eventhubs.json + - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/sku.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json + - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json ```