azure.mgmt.eventhub.v2021_01_01_preview.models module

class azure.mgmt.eventhub.v2021_01_01_preview.models.AccessKeys(**kwargs: Any)[source]

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.v2021_01_01_preview.models.AccessRights(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

AccessRights.

LISTEN = 'Listen'
MANAGE = 'Manage'
SEND = 'Send'
class azure.mgmt.eventhub.v2021_01_01_preview.models.ArmDisasterRecovery(*, partner_namespace: str | None = None, alternate_name: str | None = None, **kwargs: Any)[source]

Bases: Resource

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.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • 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.v2021_01_01_preview.models.ArmDisasterRecoveryListResult(*, value: List[_models.ArmDisasterRecovery] | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.AuthorizationRule(*, rights: List[str | _models.AccessRights] | None = None, **kwargs: Any)[source]

Bases: Resource

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.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • 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.v2021_01_01_preview.models.AuthorizationRuleListResult(*, value: List[_models.AuthorizationRule] | None = None, next_link: str | None = None, **kwargs: Any)[source]

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.v2021_01_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)[source]

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.v2021_01_01_preview.models.CheckNameAvailabilityParameter(*, name: str, **kwargs: Any)[source]

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.v2021_01_01_preview.models.CheckNameAvailabilityResult(*, name_available: bool | None = None, reason: str | _models.UnavailableReason | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties(**kwargs: Any)[source]

Bases: Model

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties.

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.v2021_01_01_preview.models.ConnectionState(*, status: str | _models.PrivateLinkConnectionStatus | None = None, description: str | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.ConsumerGroup(*, user_metadata: str | None = None, **kwargs: Any)[source]

Bases: Resource

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.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • 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.v2021_01_01_preview.models.ConsumerGroupListResult(*, value: List[_models.ConsumerGroup] | None = None, next_link: str | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.eventhub.v2021_01_01_preview.models.DefaultAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Default Action for Network Rule Set.

ALLOW = 'Allow'
DENY = 'Deny'
class azure.mgmt.eventhub.v2021_01_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, **kwargs: Any)[source]

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.

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.

class azure.mgmt.eventhub.v2021_01_01_preview.models.EHNamespace(*, location: str | None = None, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, cluster_arm_id: str | None = None, is_auto_inflate_enabled: bool | None = None, 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, **kwargs: Any)[source]

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.

  • 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.

  • 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.

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.

  • 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.

  • 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.

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

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.v2021_01_01_preview.models.EncodingCaptureDescription(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

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.v2021_01_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)[source]

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.v2021_01_01_preview.models.EndPointProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

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.v2021_01_01_preview.models.EntityStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

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.v2021_01_01_preview.models.ErrorResponse(*, code: str | None = None, message: str | None = None, **kwargs: Any)[source]

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:

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

Keyword Arguments:

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

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

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.v2021_01_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, **kwargs: Any)[source]

Bases: Resource

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.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • 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.

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.

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

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:
Keyword Arguments:
class azure.mgmt.eventhub.v2021_01_01_preview.models.KeyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The access key to regenerate.

PRIMARY_KEY = 'PrimaryKey'
SECONDARY_KEY = 'SecondaryKey'
class azure.mgmt.eventhub.v2021_01_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)[source]

Bases: Model

Properties to configure keyVault Properties.

Variables:
Keyword Arguments:
class azure.mgmt.eventhub.v2021_01_01_preview.models.ManagedServiceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

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.v2021_01_01_preview.models.NWRuleSetIpRules(*, ip_mask: str | None = None, action: str | _models.NetworkRuleIPAction | None = None, **kwargs: Any)[source]

Bases: Model

The response from the List namespace operation.

Variables:
Keyword Arguments:
class azure.mgmt.eventhub.v2021_01_01_preview.models.NWRuleSetVirtualNetworkRules(*, subnet: _models.Subnet | None = None, ignore_missing_vnet_service_endpoint: bool | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.NetworkRuleIPAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The IP Filter Action.

ALLOW = 'Allow'
class azure.mgmt.eventhub.v2021_01_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, **kwargs: Any)[source]

Bases: Resource

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.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • 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.

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.

class azure.mgmt.eventhub.v2021_01_01_preview.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

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}.

  • display (OperationDisplay) – The object that represents the operation.

Keyword Arguments:

display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.eventhub.v2021_01_01_preview.models.OperationDisplay(**kwargs: Any)[source]

Bases: Model

The object that represents the operation.

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

Variables:

  • provider (str) – Service provider: Microsoft.EventHub.

  • resource (str) – Resource on which the operation is performed: Invoice, etc.

  • operation (str) – Operation type: Read, write, delete, etc.

class azure.mgmt.eventhub.v2021_01_01_preview.models.OperationListResult(**kwargs: Any)[source]

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.v2021_01_01_preview.models.PrivateEndpoint(*, id: str | None = None, **kwargs: Any)[source]

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.v2021_01_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)[source]

Bases: Resource

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.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • 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.v2021_01_01_preview.models.PrivateEndpointConnectionListResult(*, value: List[_models.PrivateEndpointConnection] | None = None, next_link: str | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.PrivateLinkConnectionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Status of the connection.

APPROVED = 'Approved'
DISCONNECTED = 'Disconnected'
PENDING = 'Pending'
REJECTED = 'Rejected'
class azure.mgmt.eventhub.v2021_01_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)[source]

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.v2021_01_01_preview.models.PrivateLinkResourcesListResult(*, value: List[_models.PrivateLinkResource] | None = None, next_link: str | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.ProvisioningStateDR(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

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.v2021_01_01_preview.models.RegenerateAccessKeyParameters(*, key_type: str | _models.KeyType, key: str | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.Resource(**kwargs: Any)[source]

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.v2021_01_01_preview.models.RoleDisasterRecovery(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

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.v2021_01_01_preview.models.Sku(*, name: str | _models.SkuName, tier: str | _models.SkuTier | None = None, capacity: int | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.SkuName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Name of this SKU.

BASIC = 'Basic'
PREMIUM = 'Premium'
STANDARD = 'Standard'
class azure.mgmt.eventhub.v2021_01_01_preview.models.SkuTier(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The billing tier of this particular SKU.

BASIC = 'Basic'
PREMIUM = 'Premium'
STANDARD = 'Standard'
class azure.mgmt.eventhub.v2021_01_01_preview.models.Subnet(*, id: str | None = None, **kwargs: Any)[source]

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.v2021_01_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)[source]

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.v2021_01_01_preview.models.TrackedResource(*, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

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.v2021_01_01_preview.models.UnavailableReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

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.v2021_01_01_preview.models.UserAssignedIdentityProperties(*, user_assigned_identity: str | None = None, **kwargs: Any)[source]

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.