Share via

EventHubManagementClient Class

  • Reference

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

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Inheritance
MultiApiClientMixin
EventHubManagementClient
azure.mgmt.eventhub._event_hub_management_client._SDKClient
EventHubManagementClient

Constructor

EventHubManagementClient(credential: TokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)

Parameters

Name Description
credential
Required
TokenCredential

Credential needed for the client to connect to Azure. Required.
subscription_id
Required
str

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. Required.
api_version
str

API version to use if no profile is provided, or if missing in profile.

Default value: None
base_url
str

Service URL

Default value: https://management.azure.com
profile
KnownProfiles

A profile definition, from KnownProfiles to dict.

Default value: KnownProfiles.default

Keyword-Only Parameters

Name Description
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Methods

close
models

Module depends on the API version:

close 

close()

models

Module depends on the API version:

models(api_version='2024-01-01')

Parameters

Name Description
api_version
Default value: 2024-01-01

Attributes

application_group

Instance depends on the API version:

clusters

Instance depends on the API version:

configuration

Instance depends on the API version:

consumer_groups

Instance depends on the API version:

disaster_recovery_configs

Instance depends on the API version:

event_hubs

Instance depends on the API version:

namespaces

Instance depends on the API version:

network_security_perimeter_configuration

Instance depends on the API version:

network_security_perimeter_configurations

Instance depends on the API version:

operations

Instance depends on the API version:

private_endpoint_connections

Instance depends on the API version:

Instance depends on the API version:

regions

Instance depends on the API version:

schema_registry

Instance depends on the API version:

DEFAULT_API_VERSION 

DEFAULT_API_VERSION = '2024-01-01'

LATEST_PROFILE 

LATEST_PROFILE = azure.mgmt.eventhub.EventHubManagementClient latest