azure.mgmt.eventhub.v2022_10_01_preview.models module

class azure.mgmt.eventhub.v2022_10_01_preview.models.AccessKeys(**kwargs: Any)

Bases: Model

Namespace/EventHub Connection String.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• primary_connection_string (str) – Primary connection string of the created namespace AuthorizationRule.

• secondary_connection_string (str) – Secondary connection string of the created namespace AuthorizationRule.

• alias_primary_connection_string (str) – Primary connection string of the alias if GEO DR is enabled.

• alias_secondary_connection_string (str) – Secondary connection string of the alias if GEO DR is enabled.

• primary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.

• secondary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.

• key_name (str) – A string that describes the AuthorizationRule.

class azure.mgmt.eventhub.v2022_10_01_preview.models.AccessRights(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

AccessRights.

LISTEN = 'Listen'

MANAGE = 'Manage'

SEND = 'Send'

class azure.mgmt.eventhub.v2022_10_01_preview.models.ApplicationGroup(*, is_enabled: bool | None = None, client_app_group_identifier: str | None = None, policies: List[_models.ApplicationGroupPolicy] | None = None, **kwargs: Any)

Bases: ProxyResource

The Application Group object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• is_enabled (bool) – Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed.

• client_app_group_identifier (str) – The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid).

• policies (list[ApplicationGroupPolicy]) – List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic.

Keyword Arguments:

• is_enabled (bool) – Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed.

• client_app_group_identifier (str) – The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid).

• policies (list[ApplicationGroupPolicy]) – List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ApplicationGroupListResult(*, value: List[_models.ApplicationGroup] | None = None, **kwargs: Any)

Bases: Model

The response from the List Application Groups operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• value (list[ApplicationGroup]) – Result of the List Application Groups operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules.

Keyword Arguments:

value (list[ApplicationGroup]) – Result of the List Application Groups operation.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ApplicationGroupPolicy(*, name: str, **kwargs: Any)

Bases: Model

Properties of the Application Group policy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ThrottlingPolicy

All required parameters must be populated in order to send to server.

Variables:

• name (str) – The Name of this policy. Required.

• type (str or ApplicationGroupPolicyType) – Application Group Policy types. Required. “ThrottlingPolicy”

Keyword Arguments:

name (str) – The Name of this policy. Required.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ApplicationGroupPolicyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Application Group Policy types.

THROTTLING_POLICY = 'ThrottlingPolicy'

class azure.mgmt.eventhub.v2022_10_01_preview.models.ArmDisasterRecovery(*, partner_namespace: str | None = None, alternate_name: str | None = None, **kwargs: Any)

Bases: ProxyResource

Single item in List or Get Alias(Disaster Recovery configuration) operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• provisioning_state (str or ProvisioningStateDR) – Provisioning state of the Alias(Disaster Recovery configuration) - possible values ‘Accepted’ or ‘Succeeded’ or ‘Failed’. Known values are: “Accepted”, “Succeeded”, and “Failed”.

• partner_namespace (str) – ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing.

• alternate_name (str) – Alternate name specified when alias and namespace names are same.

• role (str or RoleDisasterRecovery) – role of namespace in GEO DR - possible values ‘Primary’ or ‘PrimaryNotReplicating’ or ‘Secondary’. Known values are: “Primary”, “PrimaryNotReplicating”, and “Secondary”.

• pending_replication_operations_count (int) – Number of entities pending to be replicated.

Keyword Arguments:

• partner_namespace (str) – ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing.

• alternate_name (str) – Alternate name specified when alias and namespace names are same.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ArmDisasterRecoveryListResult(*, value: List[_models.ArmDisasterRecovery] | None = None, **kwargs: Any)

Bases: Model

The result of the List Alias(Disaster Recovery configuration) operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• value (list[ArmDisasterRecovery]) – List of Alias(Disaster Recovery configurations).

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration).

Keyword Arguments:

value (list[ArmDisasterRecovery]) – List of Alias(Disaster Recovery configurations).

class azure.mgmt.eventhub.v2022_10_01_preview.models.AuthorizationRule(*, rights: List[str | _models.AccessRights] | None = None, **kwargs: Any)

Bases: ProxyResource

Single item in a List or Get AuthorizationRule operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• rights (list[str or AccessRights]) – The rights associated with the rule.

Keyword Arguments:

rights (list[str or AccessRights]) – The rights associated with the rule.

class azure.mgmt.eventhub.v2022_10_01_preview.models.AuthorizationRuleListResult(*, value: List[_models.AuthorizationRule] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

The response from the List namespace operation.

Variables:

• value (list[AuthorizationRule]) – Result of the List Authorization Rules operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules.

Keyword Arguments:

• value (list[AuthorizationRule]) – Result of the List Authorization Rules operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules.

class azure.mgmt.eventhub.v2022_10_01_preview.models.AvailableCluster(*, location: str | None = None, **kwargs: Any)

Bases: Model

Pre-provisioned and readily available Event Hubs Cluster count per region.

Variables:

location (str) – Location fo the Available Cluster.

Keyword Arguments:

location (str) – Location fo the Available Cluster.

class azure.mgmt.eventhub.v2022_10_01_preview.models.AvailableClustersList(*, value: List[_models.AvailableCluster] | None = None, **kwargs: Any)

Bases: Model

The response of the List Available Clusters operation.

Variables:

value (list[AvailableCluster]) – The count of readily available and pre-provisioned Event Hubs Clusters per region.

Keyword Arguments:

value (list[AvailableCluster]) – The count of readily available and pre-provisioned Event Hubs Clusters per region.

class azure.mgmt.eventhub.v2022_10_01_preview.models.CaptureDescription(*, enabled: bool | None = None, encoding: str | _models.EncodingCaptureDescription | None = None, interval_in_seconds: int | None = None, size_limit_in_bytes: int | None = None, destination: _models.Destination | None = None, skip_empty_archives: bool | None = None, **kwargs: Any)

Bases: Model

Properties to configure capture description for eventhub.

Variables:

• enabled (bool) – A value that indicates whether capture description is enabled.

• encoding (str or EncodingCaptureDescription) – Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version. Known values are: “Avro” and “AvroDeflate”.

• interval_in_seconds (int) – 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.

• size_limit_in_bytes (int) – 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 (Destination) – Properties of Destination where capture will be stored. (Storage Account, Blob Names).

• skip_empty_archives (bool) – A value that indicates whether to Skip Empty Archives.

Keyword Arguments:

• enabled (bool) – A value that indicates whether capture description is enabled.

• encoding (str or EncodingCaptureDescription) – Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version. Known values are: “Avro” and “AvroDeflate”.

• interval_in_seconds (int) – 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.

• size_limit_in_bytes (int) – 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 (Destination) – Properties of Destination where capture will be stored. (Storage Account, Blob Names).

• skip_empty_archives (bool) – A value that indicates whether to Skip Empty Archives.

class azure.mgmt.eventhub.v2022_10_01_preview.models.CheckNameAvailabilityParameter(*, name: str, **kwargs: Any)

Bases: Model

Parameter supplied to check Namespace name availability operation.

All required parameters must be populated in order to send to server.

Variables:

name (str) – Name to check the namespace name availability. Required.

Keyword Arguments:

name (str) – Name to check the namespace name availability. Required.

class azure.mgmt.eventhub.v2022_10_01_preview.models.CheckNameAvailabilityResult(*, name_available: bool | None = None, reason: str | _models.UnavailableReason | None = None, **kwargs: Any)

Bases: Model

The Result of the CheckNameAvailability operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• message (str) – The detailed info regarding the reason associated with the Namespace.

• name_available (bool) – Value indicating Namespace is availability, true if the Namespace is available; otherwise, false.

• reason (str or UnavailableReason) – The reason for unavailability of a Namespace. Known values are: “None”, “InvalidName”, “SubscriptionIsDisabled”, “NameInUse”, “NameInLockdown”, and “TooManyNamespaceInCurrentSubscription”.

Keyword Arguments:

• name_available (bool) – Value indicating Namespace is availability, true if the Namespace is available; otherwise, false.

• reason (str or UnavailableReason) – The reason for unavailability of a Namespace. Known values are: “None”, “InvalidName”, “SubscriptionIsDisabled”, “NameInUse”, “NameInLockdown”, and “TooManyNamespaceInCurrentSubscription”.

class azure.mgmt.eventhub.v2022_10_01_preview.models.CleanupPolicyRetentionDescription(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Enumerates the possible values for cleanup policy.

COMPACT = 'Compact'

DELETE = 'Delete'

class azure.mgmt.eventhub.v2022_10_01_preview.models.Cluster(*, location: str | None = None, tags: Dict[str, str] | None = None, sku: _models.ClusterSku | None = None, supports_scaling: bool | None = None, **kwargs: Any)

Bases: TrackedResource

Single Event Hubs Cluster resource in List or Get operations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• location (str) – Resource location.

• tags (dict[str, str]) – Resource tags.

• sku (ClusterSku) – Properties of the cluster SKU.

• system_data (SystemData) – The system meta data relating to this resource.

• created_at (str) – The UTC time when the Event Hubs Cluster was created.

• updated_at (str) – The UTC time when the Event Hubs Cluster was last updated.

• metric_id (str) – The metric ID of the cluster resource. Provided by the service and not modifiable by the user.

• status (str) – Status of the Cluster resource.

• supports_scaling (bool) – A value that indicates whether Scaling is Supported.

Keyword Arguments:

• location (str) – Resource location.

• tags (dict[str, str]) – Resource tags.

• sku (ClusterSku) – Properties of the cluster SKU.

• supports_scaling (bool) – A value that indicates whether Scaling is Supported.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ClusterListResult(*, value: List[_models.Cluster] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

The response of the List Event Hubs Clusters operation.

Variables:

• value (list[Cluster]) – The Event Hubs Clusters present in the List Event Hubs operation results.

• next_link (str) – Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters.

Keyword Arguments:

• value (list[Cluster]) – The Event Hubs Clusters present in the List Event Hubs operation results.

• next_link (str) – Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ClusterQuotaConfigurationProperties(*, settings: Dict[str, str] | None = None, **kwargs: Any)

Bases: Model

Contains all settings for the cluster.

Variables:

settings (dict[str, str]) – All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster.

Keyword Arguments:

settings (dict[str, str]) – All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ClusterSku(*, name: str | _models.ClusterSkuName, capacity: int | None = None, **kwargs: Any)

Bases: Model

SKU parameters particular to a cluster instance.

All required parameters must be populated in order to send to server.

Variables:

• name (str or ClusterSkuName) – Name of this SKU. Required. “Dedicated”

• capacity (int) – The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

Keyword Arguments:

• name (str or ClusterSkuName) – Name of this SKU. Required. “Dedicated”

• capacity (int) – The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ClusterSkuName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Name of this SKU.

DEDICATED = 'Dedicated'

class azure.mgmt.eventhub.v2022_10_01_preview.models.ConnectionState(*, status: str | _models.PrivateLinkConnectionStatus | None = None, description: str | None = None, **kwargs: Any)

Bases: Model

ConnectionState information.

Variables:

• status (str or PrivateLinkConnectionStatus) – Status of the connection. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

• description (str) – Description of the connection state.

Keyword Arguments:

• status (str or PrivateLinkConnectionStatus) – Status of the connection. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

• description (str) – Description of the connection state.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ConsumerGroup(*, user_metadata: str | None = None, **kwargs: Any)

Bases: ProxyResource

Single item in List or Get Consumer group operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• created_at (datetime) – Exact time the message was created.

• updated_at (datetime) – The exact time the message was updated.

• user_metadata (str) – 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.

Keyword Arguments:

user_metadata (str) – 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.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ConsumerGroupListResult(*, value: List[_models.ConsumerGroup] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

The result to the List Consumer Group operation.

Variables:

• value (list[ConsumerGroup]) – Result of the List Consumer Group operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of Consumer Group.

Keyword Arguments:

• value (list[ConsumerGroup]) – Result of the List Consumer Group operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of Consumer Group.

class azure.mgmt.eventhub.v2022_10_01_preview.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'

KEY = 'Key'

MANAGED_IDENTITY = 'ManagedIdentity'

USER = 'User'

class azure.mgmt.eventhub.v2022_10_01_preview.models.DefaultAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Default Action for Network Rule Set.

ALLOW = 'Allow'

DENY = 'Deny'

class azure.mgmt.eventhub.v2022_10_01_preview.models.Destination(*, name: str | None = None, storage_account_resource_id: str | None = None, blob_container: str | None = None, archive_name_format: str | None = None, data_lake_subscription_id: str | None = None, data_lake_account_name: str | None = None, data_lake_folder_path: str | None = None, **kwargs: Any)

Bases: Model

Capture storage details for capture description.

Variables:

• name (str) – Name for capture destination.

• storage_account_resource_id (str) – Resource id of the storage account to be used to create the blobs.

• blob_container (str) – Blob container Name.

• archive_name_format (str) – 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.

• data_lake_subscription_id (str) – Subscription Id of Azure Data Lake Store.

• data_lake_account_name (str) – The Azure Data Lake Store name for the captured events.

• data_lake_folder_path (str) – The destination folder path for the captured events.

Keyword Arguments:

• name (str) – Name for capture destination.

• storage_account_resource_id (str) – Resource id of the storage account to be used to create the blobs.

• blob_container (str) – Blob container Name.

• archive_name_format (str) – 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.

• data_lake_subscription_id (str) – Subscription Id of Azure Data Lake Store.

• data_lake_account_name (str) – The Azure Data Lake Store name for the captured events.

• data_lake_folder_path (str) – The destination folder path for the captured events.

class azure.mgmt.eventhub.v2022_10_01_preview.models.EHNamespace(*, location: str | None = None, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, minimum_tls_version: str | _models.TlsVersion | None = None, cluster_arm_id: str | None = None, is_auto_inflate_enabled: bool | None = None, public_network_access: str | _models.PublicNetworkAccess = 'Enabled', maximum_throughput_units: int | None = None, kafka_enabled: bool | None = None, zone_redundant: bool | None = None, encryption: _models.Encryption | None = None, private_endpoint_connections: List[_models.PrivateEndpointConnection] | None = None, disable_local_auth: bool | None = None, alternate_name: str | None = None, **kwargs: Any)

Bases: TrackedResource

Single Namespace item in List or Get Operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• location (str) – Resource location.

• tags (dict[str, str]) – Resource tags.

• sku (Sku) – Properties of sku resource.

• identity (Identity) – Properties of BYOK Identity description.

• system_data (SystemData) – The system meta data relating to this resource.

• minimum_tls_version (str or TlsVersion) – The minimum TLS version for the cluster to support, e.g. ‘1.2’. Known values are: “1.0”, “1.1”, and “1.2”.

• provisioning_state (str) – Provisioning state of the Namespace.

• status (str) – Status of the Namespace.

• created_at (datetime) – The time the Namespace was created.

• updated_at (datetime) – The time the Namespace was updated.

• service_bus_endpoint (str) – Endpoint you can use to perform Service Bus operations.

• cluster_arm_id (str) – Cluster ARM ID of the Namespace.

• metric_id (str) – Identifier for Azure Insights metrics.

• is_auto_inflate_enabled (bool) – Value that indicates whether AutoInflate is enabled for eventhub namespace.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• maximum_throughput_units (int) – Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true).

• kafka_enabled (bool) – Value that indicates whether Kafka is enabled for eventhub namespace.

• zone_redundant (bool) – Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

• encryption (Encryption) – Properties of BYOK Encryption description.

• private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.

• disable_local_auth (bool) – This property disables SAS authentication for the Event Hubs namespace.

• alternate_name (str) – Alternate name specified when alias and namespace names are same.

Keyword Arguments:

• location (str) – Resource location.

• tags (dict[str, str]) – Resource tags.

• sku (Sku) – Properties of sku resource.

• identity (Identity) – Properties of BYOK Identity description.

• minimum_tls_version (str or TlsVersion) – The minimum TLS version for the cluster to support, e.g. ‘1.2’. Known values are: “1.0”, “1.1”, and “1.2”.

• cluster_arm_id (str) – Cluster ARM ID of the Namespace.

• is_auto_inflate_enabled (bool) – Value that indicates whether AutoInflate is enabled for eventhub namespace.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• maximum_throughput_units (int) – Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true).

• kafka_enabled (bool) – Value that indicates whether Kafka is enabled for eventhub namespace.

• zone_redundant (bool) – Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

• encryption (Encryption) – Properties of BYOK Encryption description.

• private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.

• disable_local_auth (bool) – This property disables SAS authentication for the Event Hubs namespace.

• alternate_name (str) – Alternate name specified when alias and namespace names are same.

class azure.mgmt.eventhub.v2022_10_01_preview.models.EHNamespaceIdContainer(*, id: str | None = None, **kwargs: Any)

Bases: Model

The full ARM ID of an Event Hubs Namespace.

Variables:

id (str) – id parameter.

Keyword Arguments:

id (str) – id parameter.

class azure.mgmt.eventhub.v2022_10_01_preview.models.EHNamespaceIdListResult(*, value: List[_models.EHNamespaceIdContainer] | None = None, **kwargs: Any)

Bases: Model

The response of the List Namespace IDs operation.

Variables:

value (list[EHNamespaceIdContainer]) – Result of the List Namespace IDs operation.

Keyword Arguments:

value (list[EHNamespaceIdContainer]) – Result of the List Namespace IDs operation.

class azure.mgmt.eventhub.v2022_10_01_preview.models.EHNamespaceListResult(*, value: List[_models.EHNamespace] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

The response of the List Namespace operation.

Variables:

• value (list[EHNamespace]) – Result of the List Namespace operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of namespaces.

Keyword Arguments:

• value (list[EHNamespace]) – Result of the List Namespace operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of namespaces.

class azure.mgmt.eventhub.v2022_10_01_preview.models.EncodingCaptureDescription(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version.

AVRO = 'Avro'

AVRO_DEFLATE = 'AvroDeflate'

class azure.mgmt.eventhub.v2022_10_01_preview.models.Encryption(*, key_vault_properties: List[_models.KeyVaultProperties] | None = None, key_source: Literal['Microsoft.KeyVault'] = 'Microsoft.KeyVault', require_infrastructure_encryption: bool | None = None, **kwargs: Any)

Bases: Model

Properties to configure Encryption.

Variables:

• key_vault_properties (list[KeyVaultProperties]) – Properties of KeyVault.

• key_source (str) – Enumerates the possible value of keySource for Encryption. Default value is “Microsoft.KeyVault”.

• require_infrastructure_encryption (bool) – Enable Infrastructure Encryption (Double Encryption).

Keyword Arguments:

• key_vault_properties (list[KeyVaultProperties]) – Properties of KeyVault.

• key_source (str) – Enumerates the possible value of keySource for Encryption. Default value is “Microsoft.KeyVault”.

• require_infrastructure_encryption (bool) – Enable Infrastructure Encryption (Double Encryption).

class azure.mgmt.eventhub.v2022_10_01_preview.models.EndPointProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Provisioning state of the Private Endpoint Connection.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventhub.v2022_10_01_preview.models.EntityStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Enumerates the possible values for the status of the Event Hub.

ACTIVE = 'Active'

CREATING = 'Creating'

DELETING = 'Deleting'

DISABLED = 'Disabled'

RECEIVE_DISABLED = 'ReceiveDisabled'

RENAMING = 'Renaming'

RESTORING = 'Restoring'

SEND_DISABLED = 'SendDisabled'

UNKNOWN = 'Unknown'

class azure.mgmt.eventhub.v2022_10_01_preview.models.ErrorAdditionalInfo(**kwargs: Any)

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• type (str) – The additional info type.

• info (JSON) – The additional info.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ErrorDetail(**kwargs: Any)

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• code (str) – The error code.

• message (str) – The error message.

• target (str) – The error target.

• details (list[ErrorDetail]) – The error details.

• additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)

Bases: Model

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.

Variables:

error (ErrorDetail) – The error object.

Keyword Arguments:

error (ErrorDetail) – The error object.

class azure.mgmt.eventhub.v2022_10_01_preview.models.EventHubListResult(*, value: List[_models.Eventhub] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

The result of the List EventHubs operation.

Variables:

• value (list[Eventhub]) – Result of the List EventHubs operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of EventHubs.

Keyword Arguments:

• value (list[Eventhub]) – Result of the List EventHubs operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of EventHubs.

class azure.mgmt.eventhub.v2022_10_01_preview.models.Eventhub(*, message_retention_in_days: int | None = None, partition_count: int | None = None, status: str | _models.EntityStatus | None = None, capture_description: _models.CaptureDescription | None = None, retention_description: _models.RetentionDescription | None = None, **kwargs: Any)

Bases: ProxyResource

Single item in List or Get Event Hub operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• partition_ids (list[str]) – Current number of shards on the Event Hub.

• created_at (datetime) – Exact time the Event Hub was created.

• updated_at (datetime) – The exact time the message was updated.

• message_retention_in_days (int) – Number of days to retain the events for this Event Hub, value should be 1 to 7 days.

• partition_count (int) – Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

• status (str or EntityStatus) – Enumerates the possible values for the status of the Event Hub. Known values are: “Active”, “Disabled”, “Restoring”, “SendDisabled”, “ReceiveDisabled”, “Creating”, “Deleting”, “Renaming”, and “Unknown”.

• capture_description (CaptureDescription) – Properties of capture description.

• retention_description (RetentionDescription) – Event Hub retention settings.

Keyword Arguments:

• message_retention_in_days (int) – Number of days to retain the events for this Event Hub, value should be 1 to 7 days.

• partition_count (int) – Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

• status (str or EntityStatus) – Enumerates the possible values for the status of the Event Hub. Known values are: “Active”, “Disabled”, “Restoring”, “SendDisabled”, “ReceiveDisabled”, “Creating”, “Deleting”, “Renaming”, and “Unknown”.

• capture_description (CaptureDescription) – Properties of capture description.

• retention_description (RetentionDescription) – Event Hub retention settings.

class azure.mgmt.eventhub.v2022_10_01_preview.models.Identity(*, type: str | _models.ManagedServiceIdentityType | None = None, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)

Bases: Model

Properties to configure Identity for Bring your Own Keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• principal_id (str) – ObjectId from the KeyVault.

• tenant_id (str) – TenantId from the KeyVault.

• type (str or ManagedServiceIdentityType) – Type of managed service identity. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

• user_assigned_identities (dict[str, UserAssignedIdentity]) – Properties for User Assigned Identities.

Keyword Arguments:

• type (str or ManagedServiceIdentityType) – Type of managed service identity. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

• user_assigned_identities (dict[str, UserAssignedIdentity]) – Properties for User Assigned Identities.

class azure.mgmt.eventhub.v2022_10_01_preview.models.KeyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The access key to regenerate.

PRIMARY_KEY = 'PrimaryKey'

SECONDARY_KEY = 'SecondaryKey'

class azure.mgmt.eventhub.v2022_10_01_preview.models.KeyVaultProperties(*, key_name: str | None = None, key_vault_uri: str | None = None, key_version: str | None = None, identity: _models.UserAssignedIdentityProperties | None = None, **kwargs: Any)

Bases: Model

Properties to configure keyVault Properties.

Variables:

• key_name (str) – Name of the Key from KeyVault.

• key_vault_uri (str) – Uri of KeyVault.

• key_version (str) – Key Version.

• identity (UserAssignedIdentityProperties)

Keyword Arguments:

• key_name (str) – Name of the Key from KeyVault.

• key_vault_uri (str) – Uri of KeyVault.

• key_version (str) – Key Version.

• identity (UserAssignedIdentityProperties)

class azure.mgmt.eventhub.v2022_10_01_preview.models.ManagedServiceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Type of managed service identity.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.eventhub.v2022_10_01_preview.models.MetricId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal.

INCOMING_BYTES = 'IncomingBytes'

INCOMING_MESSAGES = 'IncomingMessages'

OUTGOING_BYTES = 'OutgoingBytes'

OUTGOING_MESSAGES = 'OutgoingMessages'

class azure.mgmt.eventhub.v2022_10_01_preview.models.NWRuleSetIpRules(*, ip_mask: str | None = None, action: str | _models.NetworkRuleIPAction | None = None, **kwargs: Any)

Bases: Model

The response from the List namespace operation.

Variables:

• ip_mask (str) – IP Mask.

• action (str or NetworkRuleIPAction) – The IP Filter Action. “Allow”

Keyword Arguments:

• ip_mask (str) – IP Mask.

• action (str or NetworkRuleIPAction) – The IP Filter Action. “Allow”

class azure.mgmt.eventhub.v2022_10_01_preview.models.NWRuleSetVirtualNetworkRules(*, subnet: _models.Subnet | None = None, ignore_missing_vnet_service_endpoint: bool | None = None, **kwargs: Any)

Bases: Model

The response from the List namespace operation.

Variables:

• subnet (Subnet) – Subnet properties.

• ignore_missing_vnet_service_endpoint (bool) – Value that indicates whether to ignore missing Vnet Service Endpoint.

Keyword Arguments:

• subnet (Subnet) – Subnet properties.

• ignore_missing_vnet_service_endpoint (bool) – Value that indicates whether to ignore missing Vnet Service Endpoint.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkRuleIPAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The IP Filter Action.

ALLOW = 'Allow'

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkRuleSet(*, trusted_service_access_enabled: bool | None = None, default_action: str | _models.DefaultAction | None = None, virtual_network_rules: List[_models.NWRuleSetVirtualNetworkRules] | None = None, ip_rules: List[_models.NWRuleSetIpRules] | None = None, public_network_access: str | _models.PublicNetworkAccessFlag = 'Enabled', **kwargs: Any)

Bases: ProxyResource

Description of topic resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• trusted_service_access_enabled (bool) – Value that indicates whether Trusted Service Access is Enabled or not.

• default_action (str or DefaultAction) – Default Action for Network Rule Set. Known values are: “Allow” and “Deny”.

• virtual_network_rules (list[NWRuleSetVirtualNetworkRules]) – List VirtualNetwork Rules.

• ip_rules (list[NWRuleSetIpRules]) – List of IpRules.

• public_network_access (str or PublicNetworkAccessFlag) – This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile’s access rules. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

Keyword Arguments:

• trusted_service_access_enabled (bool) – Value that indicates whether Trusted Service Access is Enabled or not.

• default_action (str or DefaultAction) – Default Action for Network Rule Set. Known values are: “Allow” and “Deny”.

• virtual_network_rules (list[NWRuleSetVirtualNetworkRules]) – List VirtualNetwork Rules.

• ip_rules (list[NWRuleSetIpRules]) – List of IpRules.

• public_network_access (str or PublicNetworkAccessFlag) – This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile’s access rules. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkRuleSetListResult(*, value: List[_models.NetworkRuleSet] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

The response of the List NetworkRuleSet operation.

Variables:

• value (list[NetworkRuleSet]) – Result of the List NetworkRuleSet operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet.

Keyword Arguments:

• value (list[NetworkRuleSet]) – Result of the List NetworkRuleSet operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkSecurityPerimeter(*, id: str | None = None, perimeter_guid: str | None = None, location: str | None = None, **kwargs: Any)

Bases: Model

NetworkSecurityPerimeter related information.

Variables:

• id (str) – Fully qualified identifier of the resource.

• perimeter_guid (str) – Guid of the resource.

• location (str) – Location of the resource.

Keyword Arguments:

• id (str) – Fully qualified identifier of the resource.

• perimeter_guid (str) – Guid of the resource.

• location (str) – Location of the resource.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkSecurityPerimeterConfiguration(*, provisioning_state: str | _models.NetworkSecurityPerimeterConfigurationProvisioningState | None = None, provisioning_issues: List[_models.ProvisioningIssue] | None = None, **kwargs: Any)

Bases: ProxyResource

Network Security Perimeter related configurations of a given namespace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• provisioning_state (str or NetworkSecurityPerimeterConfigurationProvisioningState) – Provisioning state of NetworkSecurityPerimeter configuration propagation. Known values are: “Unknown”, “Creating”, “Updating”, “Accepted”, “InvalidResponse”, “Succeeded”, “SucceededWithIssues”, “Failed”, “Deleting”, “Deleted”, and “Canceled”.

• provisioning_issues (list[ProvisioningIssue]) – List of Provisioning Issues if any.

• network_security_perimeter (NetworkSecurityPerimeter) – NetworkSecurityPerimeter related information.

• resource_association (NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation) – Information about resource association.

• profile (NetworkSecurityPerimeterConfigurationPropertiesProfile) – Information about current network profile.

Keyword Arguments:

• provisioning_state (str or NetworkSecurityPerimeterConfigurationProvisioningState) – Provisioning state of NetworkSecurityPerimeter configuration propagation. Known values are: “Unknown”, “Creating”, “Updating”, “Accepted”, “InvalidResponse”, “Succeeded”, “SucceededWithIssues”, “Failed”, “Deleting”, “Deleted”, and “Canceled”.

• provisioning_issues (list[ProvisioningIssue]) – List of Provisioning Issues if any.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkSecurityPerimeterConfigurationList(**kwargs: Any)

Bases: Model

Result of the List NetworkSecurityPerimeterConfiguration operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[NetworkSecurityPerimeterConfiguration]) – A collection of NetworkSecurityPerimeterConfigurations.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkSecurityPerimeterConfigurationPropertiesProfile(*, name: str | None = None, access_rules_version: str | None = None, access_rules: List[_models.NspAccessRule] | None = None, **kwargs: Any)

Bases: Model

Information about current network profile.

Variables:

• name (str) – Name of the resource.

• access_rules_version (str) – Current access rules version.

• access_rules (list[NspAccessRule]) – List of Access Rules.

Keyword Arguments:

• name (str) – Name of the resource.

• access_rules_version (str) – Current access rules version.

• access_rules (list[NspAccessRule]) – List of Access Rules.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation(*, name: str | None = None, access_mode: str | _models.ResourceAssociationAccessMode | None = None, **kwargs: Any)

Bases: Model

Information about resource association.

Variables:

• name (str) – Name of the resource association.

• access_mode (str or ResourceAssociationAccessMode) – Access Mode of the resource association. Known values are: “NoAssociationMode”, “EnforcedMode”, “LearningMode”, “AuditMode”, and “UnspecifiedMode”.

Keyword Arguments:

• name (str) – Name of the resource association.

• access_mode (str or ResourceAssociationAccessMode) – Access Mode of the resource association. Known values are: “NoAssociationMode”, “EnforcedMode”, “LearningMode”, “AuditMode”, and “UnspecifiedMode”.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NetworkSecurityPerimeterConfigurationProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Provisioning state of NetworkSecurityPerimeter configuration propagation.

ACCEPTED = 'Accepted'

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETED = 'Deleted'

DELETING = 'Deleting'

FAILED = 'Failed'

INVALID_RESPONSE = 'InvalidResponse'

SUCCEEDED = 'Succeeded'

SUCCEEDED_WITH_ISSUES = 'SucceededWithIssues'

UNKNOWN = 'Unknown'

UPDATING = 'Updating'

class azure.mgmt.eventhub.v2022_10_01_preview.models.NspAccessRule(*, id: str | None = None, name: str | None = None, type: str | None = None, **kwargs: Any)

Bases: Model

Information of Access Rule in Network Profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• properties (NspAccessRuleProperties) – Properties of Access Rule.

Keyword Arguments:

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NspAccessRuleDirection(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Direction of Access Rule.

INBOUND = 'Inbound'

OUTBOUND = 'Outbound'

class azure.mgmt.eventhub.v2022_10_01_preview.models.NspAccessRuleProperties(*, direction: str | _models.NspAccessRuleDirection | None = None, address_prefixes: List[str] | None = None, subscriptions: List[_models.NspAccessRulePropertiesSubscriptionsItem] | None = None, **kwargs: Any)

Bases: Model

Properties of Access Rule.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• direction (str or NspAccessRuleDirection) – Direction of Access Rule. Known values are: “Inbound” and “Outbound”.

• address_prefixes (list[str]) – Address prefixes in the CIDR format for inbound rules.

• subscriptions (list[NspAccessRulePropertiesSubscriptionsItem]) – Subscriptions for inbound rules.

• network_security_perimeters (list[NetworkSecurityPerimeter]) – NetworkSecurityPerimeters for inbound rules.

• fully_qualified_domain_names (list[str]) – FQDN for outbound rules.

Keyword Arguments:

• direction (str or NspAccessRuleDirection) – Direction of Access Rule. Known values are: “Inbound” and “Outbound”.

• address_prefixes (list[str]) – Address prefixes in the CIDR format for inbound rules.

• subscriptions (list[NspAccessRulePropertiesSubscriptionsItem]) – Subscriptions for inbound rules.

class azure.mgmt.eventhub.v2022_10_01_preview.models.NspAccessRulePropertiesSubscriptionsItem(*, id: str | None = None, **kwargs: Any)

Bases: Model

Subscription for inbound rule.

Variables:

id (str) – Fully qualified identifier of subscription.

Keyword Arguments:

id (str) – Fully qualified identifier of subscription.

class azure.mgmt.eventhub.v2022_10_01_preview.models.Operation(*, is_data_action: bool | None = None, display: _models.OperationDisplay | None = None, origin: str | None = None, properties: MutableMapping[str, Any] | None = None, **kwargs: Any)

Bases: Model

A Event Hub REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• name (str) – Operation name: {provider}/{resource}/{operation}.

• is_data_action (bool) – Indicates whether the operation is a data action.

• display (OperationDisplay) – Display of the operation.

• origin (str) – Origin of the operation.

• properties (JSON) – Properties of the operation.

Keyword Arguments:

• is_data_action (bool) – Indicates whether the operation is a data action.

• display (OperationDisplay) – Display of the operation.

• origin (str) – Origin of the operation.

• properties (JSON) – Properties of the operation.

class azure.mgmt.eventhub.v2022_10_01_preview.models.OperationDisplay(**kwargs: Any)

Bases: Model

Operation display payload.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• provider (str) – Resource provider of the operation.

• resource (str) – Resource of the operation.

• operation (str) – Localized friendly name for the operation.

• description (str) – Localized friendly description for the operation.

class azure.mgmt.eventhub.v2022_10_01_preview.models.OperationListResult(**kwargs: Any)

Bases: Model

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.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• value (list[Operation]) – List of Event Hub operations supported by the Microsoft.EventHub resource provider.

• next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.eventhub.v2022_10_01_preview.models.PrivateEndpoint(*, id: str | None = None, **kwargs: Any)

Bases: Model

PrivateEndpoint information.

Variables:

id (str) – The ARM identifier for Private Endpoint.

Keyword Arguments:

id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.eventhub.v2022_10_01_preview.models.PrivateEndpointConnection(*, private_endpoint: _models.PrivateEndpoint | None = None, private_link_service_connection_state: _models.ConnectionState | None = None, provisioning_state: str | _models.EndPointProvisioningState | None = None, **kwargs: Any)

Bases: ProxyResource

Properties of the PrivateEndpointConnection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• private_endpoint (PrivateEndpoint) – The Private Endpoint resource for this Connection.

• private_link_service_connection_state (ConnectionState) – Details about the state of the connection.

• provisioning_state (str or EndPointProvisioningState) – Provisioning state of the Private Endpoint Connection. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

Keyword Arguments:

• private_endpoint (PrivateEndpoint) – The Private Endpoint resource for this Connection.

• private_link_service_connection_state (ConnectionState) – Details about the state of the connection.

• provisioning_state (str or EndPointProvisioningState) – Provisioning state of the Private Endpoint Connection. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

class azure.mgmt.eventhub.v2022_10_01_preview.models.PrivateEndpointConnectionListResult(*, value: List[_models.PrivateEndpointConnection] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

Result of the list of all private endpoint connections operation.

Variables:

• value (list[PrivateEndpointConnection]) – A collection of private endpoint connection resources.

• next_link (str) – A link for the next page of private endpoint connection resources.

Keyword Arguments:

• value (list[PrivateEndpointConnection]) – A collection of private endpoint connection resources.

• next_link (str) – A link for the next page of private endpoint connection resources.

class azure.mgmt.eventhub.v2022_10_01_preview.models.PrivateLinkConnectionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Status of the connection.

APPROVED = 'Approved'

DISCONNECTED = 'Disconnected'

PENDING = 'Pending'

REJECTED = 'Rejected'

class azure.mgmt.eventhub.v2022_10_01_preview.models.PrivateLinkResource(*, id: str | None = None, name: str | None = None, type: str | None = None, group_id: str | None = None, required_members: List[str] | None = None, required_zone_names: List[str] | None = None, **kwargs: Any)

Bases: Model

Information of the private link resource.

Variables:

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• group_id (str) – The private link resource group id.

• required_members (list[str]) – The private link resource required member names.

• required_zone_names (list[str]) – The private link resource Private link DNS zone name.

Keyword Arguments:

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• group_id (str) – The private link resource group id.

• required_members (list[str]) – The private link resource required member names.

• required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.eventhub.v2022_10_01_preview.models.PrivateLinkResourcesListResult(*, value: List[_models.PrivateLinkResource] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

Result of the List private link resources operation.

Variables:

• value (list[PrivateLinkResource]) – A collection of private link resources.

• next_link (str) – A link for the next page of private link resources.

Keyword Arguments:

• value (list[PrivateLinkResource]) – A collection of private link resources.

• next_link (str) – A link for the next page of private link resources.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ProvisioningIssue(*, name: str | None = None, **kwargs: Any)

Bases: Model

Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• name (str) – Name of the issue.

• properties (ProvisioningIssueProperties) – Properties of Provisioning Issue.

Keyword Arguments:

name (str) – Name of the issue.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ProvisioningIssueProperties(*, issue_type: str | None = None, description: str | None = None, **kwargs: Any)

Bases: Model

Properties of Provisioning Issue.

Variables:

• issue_type (str) – Type of Issue.

• description (str) – Description of the issue.

Keyword Arguments:

• issue_type (str) – Type of Issue.

• description (str) – Description of the issue.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ProvisioningStateDR(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Provisioning state of the Alias(Disaster Recovery configuration) - possible values ‘Accepted’ or ‘Succeeded’ or ‘Failed’.

ACCEPTED = 'Accepted'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

class azure.mgmt.eventhub.v2022_10_01_preview.models.ProxyResource(**kwargs: Any)

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

class azure.mgmt.eventhub.v2022_10_01_preview.models.PublicNetworkAccess(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

This determines if traffic is allowed over public network. By default it is enabled.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

SECURED_BY_PERIMETER = 'SecuredByPerimeter'

class azure.mgmt.eventhub.v2022_10_01_preview.models.PublicNetworkAccessFlag(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile’s access rules.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

SECURED_BY_PERIMETER = 'SecuredByPerimeter'

class azure.mgmt.eventhub.v2022_10_01_preview.models.RegenerateAccessKeyParameters(*, key_type: str | _models.KeyType, key: str | None = None, **kwargs: Any)

Bases: Model

Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.

All required parameters must be populated in order to send to server.

Variables:

• key_type (str or KeyType) – The access key to regenerate. Required. Known values are: “PrimaryKey” and “SecondaryKey”.

• key (str) – Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType.

Keyword Arguments:

• key_type (str or KeyType) – The access key to regenerate. Required. Known values are: “PrimaryKey” and “SecondaryKey”.

• key (str) – Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType.

class azure.mgmt.eventhub.v2022_10_01_preview.models.Resource(**kwargs: Any)

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ResourceAssociationAccessMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Access Mode of the resource association.

AUDIT_MODE = 'AuditMode'

ENFORCED_MODE = 'EnforcedMode'

LEARNING_MODE = 'LearningMode'

NO_ASSOCIATION_MODE = 'NoAssociationMode'

UNSPECIFIED_MODE = 'UnspecifiedMode'

class azure.mgmt.eventhub.v2022_10_01_preview.models.RetentionDescription(*, cleanup_policy: str | _models.CleanupPolicyRetentionDescription | None = None, retention_time_in_hours: int | None = None, tombstone_retention_time_in_hours: int | None = None, **kwargs: Any)

Bases: Model

Properties to configure retention settings for the eventhub.

Variables:

• cleanup_policy (str or CleanupPolicyRetentionDescription) – Enumerates the possible values for cleanup policy. Known values are: “Delete” and “Compact”.

• retention_time_in_hours (int) – Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue.

• tombstone_retention_time_in_hours (int) – Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub.

Keyword Arguments:

• cleanup_policy (str or CleanupPolicyRetentionDescription) – Enumerates the possible values for cleanup policy. Known values are: “Delete” and “Compact”.

• retention_time_in_hours (int) – Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue.

• tombstone_retention_time_in_hours (int) – Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub.

class azure.mgmt.eventhub.v2022_10_01_preview.models.RoleDisasterRecovery(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

role of namespace in GEO DR - possible values ‘Primary’ or ‘PrimaryNotReplicating’ or ‘Secondary’.

PRIMARY = 'Primary'

PRIMARY_NOT_REPLICATING = 'PrimaryNotReplicating'

SECONDARY = 'Secondary'

class azure.mgmt.eventhub.v2022_10_01_preview.models.SchemaCompatibility(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

SchemaCompatibility.

BACKWARD = 'Backward'

FORWARD = 'Forward'

NONE = 'None'

class azure.mgmt.eventhub.v2022_10_01_preview.models.SchemaGroup(*, group_properties: Dict[str, str] | None = None, schema_compatibility: str | _models.SchemaCompatibility | None = None, schema_type: str | _models.SchemaType | None = None, **kwargs: Any)

Bases: ProxyResource

Single item in List or Get Schema Group operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”.

• location (str) – The geo-location where the resource lives.

• system_data (SystemData) – The system meta data relating to this resource.

• updated_at_utc (datetime) – Exact time the Schema Group was updated.

• created_at_utc (datetime) – Exact time the Schema Group was created.

• e_tag (str) – The ETag value.

• group_properties (dict[str, str]) – dictionary object for SchemaGroup group properties.

• schema_compatibility (str or SchemaCompatibility) – Known values are: “None”, “Backward”, and “Forward”.

• schema_type (str or SchemaType) – Known values are: “Unknown” and “Avro”.

Keyword Arguments:

• group_properties (dict[str, str]) – dictionary object for SchemaGroup group properties.

• schema_compatibility (str or SchemaCompatibility) – Known values are: “None”, “Backward”, and “Forward”.

• schema_type (str or SchemaType) – Known values are: “Unknown” and “Avro”.

class azure.mgmt.eventhub.v2022_10_01_preview.models.SchemaGroupListResult(*, value: List[_models.SchemaGroup] | None = None, next_link: str | None = None, **kwargs: Any)

Bases: Model

The result of the List SchemaGroup operation.

Variables:

• value (list[SchemaGroup]) – Result of the List SchemaGroups operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of Schema Groups.

Keyword Arguments:

• value (list[SchemaGroup]) – Result of the List SchemaGroups operation.

• next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of Schema Groups.

class azure.mgmt.eventhub.v2022_10_01_preview.models.SchemaType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

SchemaType.

AVRO = 'Avro'

UNKNOWN = 'Unknown'

class azure.mgmt.eventhub.v2022_10_01_preview.models.Sku(*, name: str | _models.SkuName, tier: str | _models.SkuTier | None = None, capacity: int | None = None, **kwargs: Any)

Bases: Model

SKU parameters supplied to the create namespace operation.

All required parameters must be populated in order to send to server.

Variables:

• name (str or SkuName) – Name of this SKU. Required. Known values are: “Basic”, “Standard”, and “Premium”.

• tier (str or SkuTier) – The billing tier of this particular SKU. Known values are: “Basic”, “Standard”, and “Premium”.

• capacity (int) – The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.

Keyword Arguments:

• name (str or SkuName) – Name of this SKU. Required. Known values are: “Basic”, “Standard”, and “Premium”.

• tier (str or SkuTier) – The billing tier of this particular SKU. Known values are: “Basic”, “Standard”, and “Premium”.

• capacity (int) – The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.

class azure.mgmt.eventhub.v2022_10_01_preview.models.SkuName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Name of this SKU.

BASIC = 'Basic'

PREMIUM = 'Premium'

STANDARD = 'Standard'

class azure.mgmt.eventhub.v2022_10_01_preview.models.SkuTier(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The billing tier of this particular SKU.

BASIC = 'Basic'

PREMIUM = 'Premium'

STANDARD = 'Standard'

class azure.mgmt.eventhub.v2022_10_01_preview.models.Subnet(*, id: str | None = None, **kwargs: Any)

Bases: Model

Properties supplied for Subnet.

Variables:

id (str) – Resource ID of Virtual Network Subnet.

Keyword Arguments:

id (str) – Resource ID of Virtual Network Subnet.

class azure.mgmt.eventhub.v2022_10_01_preview.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• last_modified_at (datetime) – The type of identity that last modified the resource.

Keyword Arguments:

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• last_modified_at (datetime) – The type of identity that last modified the resource.

class azure.mgmt.eventhub.v2022_10_01_preview.models.ThrottlingPolicy(*, name: str, rate_limit_threshold: int, metric_id: str | _models.MetricId, **kwargs: Any)

Bases: ApplicationGroupPolicy

Properties of the throttling policy.

All required parameters must be populated in order to send to server.

Variables:

• name (str) – The Name of this policy. Required.

• type (str or ApplicationGroupPolicyType) – Application Group Policy types. Required. “ThrottlingPolicy”

• rate_limit_threshold (int) – The Threshold limit above which the application group will be throttled.Rate limit is always per second. Required.

• metric_id (str or MetricId) – Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal. Required. Known values are: “IncomingBytes”, “OutgoingBytes”, “IncomingMessages”, and “OutgoingMessages”.

Keyword Arguments:

• name (str) – The Name of this policy. Required.

• rate_limit_threshold (int) – The Threshold limit above which the application group will be throttled.Rate limit is always per second. Required.

• metric_id (str or MetricId) – Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal. Required. Known values are: “IncomingBytes”, “OutgoingBytes”, “IncomingMessages”, and “OutgoingMessages”.

class azure.mgmt.eventhub.v2022_10_01_preview.models.TlsVersion(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The minimum TLS version for the cluster to support, e.g. ‘1.2’.

ONE0 = '1.0'

ONE1 = '1.1'

ONE2 = '1.2'

class azure.mgmt.eventhub.v2022_10_01_preview.models.TrackedResource(*, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)

Bases: Resource

Definition of resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• location (str) – Resource location.

• tags (dict[str, str]) – Resource tags.

Keyword Arguments:

• location (str) – Resource location.

• tags (dict[str, str]) – Resource tags.

class azure.mgmt.eventhub.v2022_10_01_preview.models.UnavailableReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Specifies the reason for the unavailability of the service.

INVALID_NAME = 'InvalidName'

NAME_IN_LOCKDOWN = 'NameInLockdown'

NAME_IN_USE = 'NameInUse'

NONE = 'None'

SUBSCRIPTION_IS_DISABLED = 'SubscriptionIsDisabled'

TOO_MANY_NAMESPACE_IN_CURRENT_SUBSCRIPTION = 'TooManyNamespaceInCurrentSubscription'

class azure.mgmt.eventhub.v2022_10_01_preview.models.UserAssignedIdentity(**kwargs: Any)

Bases: Model

Recognized Dictionary value.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• principal_id (str) – Principal Id of user assigned identity.

• client_id (str) – Client Id of user assigned identity.

class azure.mgmt.eventhub.v2022_10_01_preview.models.UserAssignedIdentityProperties(*, user_assigned_identity: str | None = None, **kwargs: Any)

Bases: Model

UserAssignedIdentityProperties.

Variables:

user_assigned_identity (str) – ARM ID of user Identity selected for encryption.

Keyword Arguments:

user_assigned_identity (str) – ARM ID of user Identity selected for encryption.