Microsoft Azure

EventHub2018PreviewManagementClient

Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.

Endpoints 26

Operations

  • GETOperations_List/providers/Microsoft.EventHub/operations?api-version=stringLists all of the available Event Hub REST API operations.

Event Hubs Clusters

  • GETClusters_ListAvailableClusters/subscriptions/:subscriptionId/providers/Microsoft.EventHub/availableClusterRegions?api-version=stringList the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
  • GETClusters_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters?api-version=stringLists the available Event Hubs Clusters within an ARM resource group.

Namespaces

  • GETNamespaces_List/subscriptions/:subscriptionId/providers/Microsoft.EventHub/namespaces?api-version=stringLists all the available Namespaces within a subscription, irrespective of the resource groups.
  • GETNamespaces_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces?api-version=stringLists the available Namespaces within a resource group.
  • GETNamespaces_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName?api-version=stringGets the description of the specified namespace.
  • PUTNamespaces_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName?api-version=stringCreates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
  • DELETENamespaces_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName?api-version=stringDeletes an existing namespace. This operation also removes all associated resources under the namespace.
  • PATCHNamespaces_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName?api-version=stringCreates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
  • GETNamespaces_ListIPFilterRules/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/ipfilterrules?api-version=stringGets a list of IP Filter rules for a Namespace.
  • GETNamespaces_GetIpFilterRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/ipfilterrules/:ipFilterRuleName?api-version=stringGets an IpFilterRule for a Namespace by rule name.
  • PUTNamespaces_CreateOrUpdateIpFilterRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/ipfilterrules/:ipFilterRuleName?api-version=stringCreates or updates an IpFilterRule for a Namespace.
  • DELETENamespaces_DeleteIpFilterRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/ipfilterrules/:ipFilterRuleName?api-version=stringDeletes an IpFilterRule for a Namespace.
  • GETNamespaces_GetNetworkRuleSet/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkRuleSets/default?api-version=stringGets NetworkRuleSet for a Namespace.
  • PUTNamespaces_CreateOrUpdateNetworkRuleSet/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkRuleSets/default?api-version=stringCreate or update NetworkRuleSet for a Namespace.
  • GETNamespaces_ListVirtualNetworkRules/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/virtualnetworkrules?api-version=stringGets a list of VirtualNetwork rules for a Namespace.
  • GETNamespaces_GetVirtualNetworkRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/virtualnetworkrules/:virtualNetworkRuleName?api-version=stringGets an VirtualNetworkRule for a Namespace by rule name.
  • PUTNamespaces_CreateOrUpdateVirtualNetworkRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/virtualnetworkrules/:virtualNetworkRuleName?api-version=stringCreates or updates an VirtualNetworkRule for a Namespace.
  • DELETENamespaces_DeleteVirtualNetworkRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/virtualnetworkrules/:virtualNetworkRuleName?api-version=stringDeletes an VirtualNetworkRule for a Namespace.

Event Hubs Cluster

  • GETClusters_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName?api-version=stringGets the resource description of the specified Event Hubs Cluster.
  • PUTClusters_Put/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName?api-version=stringCreates or updates an instance of an Event Hubs Cluster.
  • DELETEClusters_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName?api-version=stringDeletes an existing Event Hubs Cluster. This operation is idempotent.
  • PATCHClusters_Patch/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName?api-version=stringModifies mutable properties on the Event Hubs Cluster. This operation is idempotent.

Event Hubs Namespace Enumeration in Cluster

  • GETClusters_ListNamespaces/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName/namespaces?api-version=stringList all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

Event Hubs Cluster Configuration

  • GETConfiguration_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName/quotaConfiguration/default?api-version=stringGet all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
  • PATCHConfiguration_Patch/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName/quotaConfiguration/default?api-version=stringReplace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
26 operations on 14 pathsGET 14PUT 5DELETE 4PATCH 3
Main resources
Namespaces 16Event Hubs Cluster 4Event Hubs Cluster Configuration 2Event Hubs Clusters 2Event Hubs Namespace Enumeration in Cluster 1Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2018-01-01-preview
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the EventHub2018PreviewManagementClient in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the EventHub2018PreviewManagementClient collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.EventHub/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the EventHub2018PreviewManagementClient?

Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources. It is listed under Developer tools and has 26 endpoints.

Who publishes the EventHub2018PreviewManagementClient?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the EventHub2018PreviewManagementClient?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the EventHub2018PreviewManagementClient?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the EventHub2018PreviewManagementClient have?

26 operations on 14 paths (14 GET, 5 PUT, 4 DELETE, 3 PATCH). The largest groups are Namespaces, Event Hubs Cluster, Event Hubs Cluster Configuration, Event Hubs Clusters.

Is forking the EventHub2018PreviewManagementClient free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.