azure.mgmt.eventhub.v2015_08_01.models module

class azure.mgmt.eventhub.v2015_08_01.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.v2015_08_01.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.v2015_08_01.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:

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

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

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.v2015_08_01.models.ConsumerGroupCreateOrUpdateParameters(*, location: str, type: str | None = None, name: str | None = None, user_metadata: str | None = None, **kwargs: Any)[source]

Bases: Model

Parameters supplied to the Create Or Update Consumer Group operation.

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

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

Variables:

  • location (str) – Location of the resource. Required.

  • type (str) – ARM type of the Namespace.

  • name (str) – Name of the consumer group.

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

  • event_hub_path (str) – The path of the Event Hub.

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

  • user_metadata (str) – The user metadata.

Keyword Arguments:

  • location (str) – Location of the resource. Required.

  • type (str) – ARM type of the Namespace.

  • name (str) – Name of the consumer group.

  • user_metadata (str) – The user metadata.

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

Bases: Model

The result to the List Consumer Group operation.

Variables:

  • value (list[ConsumerGroupResource]) – 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[ConsumerGroupResource]) – 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.v2015_08_01.models.ConsumerGroupResource(*, location: str | None = None, 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) – Resource Id.

  • name (str) – Resource name.

  • location (str) – Resource location.

  • type (str) – Resource type.

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

  • event_hub_path (str) – The path of the Event Hub.

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

  • user_metadata (str) – The user metadata.

Keyword Arguments:

  • location (str) – Resource location.

  • user_metadata (str) – The user metadata.

class azure.mgmt.eventhub.v2015_08_01.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.v2015_08_01.models.EventHubCreateOrUpdateParameters(*, location: str, type: str | None = None, name: str | None = None, message_retention_in_days: int | None = None, partition_count: int | None = None, status: str | _models.EntityStatus | None = None, **kwargs: Any)[source]

Bases: Model

Parameters supplied to the Create Or Update Event Hub operation.

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

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

Variables:

  • location (str) – Location of the resource. Required.

  • type (str) – ARM type of the Namespace.

  • name (str) – Name of the Event Hub.

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

  • message_retention_in_days (int) – Number of days to retain the events for this Event Hub.

  • partition_count (int) – Number of partitions created for the Event Hub.

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

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

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

Keyword Arguments:

  • location (str) – Location of the resource. Required.

  • type (str) – ARM type of the Namespace.

  • name (str) – Name of the Event Hub.

  • message_retention_in_days (int) – Number of days to retain the events for this Event Hub.

  • partition_count (int) – Number of partitions created for the Event Hub.

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

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

Bases: Model

The result of the List EventHubs operation.

Variables:

  • value (list[EventHubResource]) – 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[EventHubResource]) – 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.v2015_08_01.models.EventHubResource(*, location: str | None = None, message_retention_in_days: int | None = None, partition_count: int | None = None, status: str | _models.EntityStatus | 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) – Resource Id.

  • name (str) – Resource name.

  • location (str) – Resource location.

  • type (str) – Resource type.

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

  • message_retention_in_days (int) – Number of days to retain the events for this Event Hub.

  • partition_count (int) – Number of partitions created for the Event Hub.

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

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

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

Keyword Arguments:

  • location (str) – Resource location.

  • message_retention_in_days (int) – Number of days to retain the events for this Event Hub.

  • partition_count (int) – Number of partitions created for the Event Hub.

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

class azure.mgmt.eventhub.v2015_08_01.models.NamespaceCreateOrUpdateParameters(*, location: str, sku: _models.Sku | None = None, tags: Dict[str, str] | None = None, status: str | _models.NamespaceState | None = None, provisioning_state: str | None = None, created_at: datetime | None = None, updated_at: datetime | None = None, service_bus_endpoint: str | None = None, enabled: bool | None = None, **kwargs: Any)[source]

Bases: Model

Parameters supplied to the Create Or Update Namespace operation.

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

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

Variables:

  • location (str) – Namespace location. Required.

  • sku (Sku) – SKU parameters supplied to the create Namespace operation.

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

  • status (str or NamespaceState) – State of the Namespace. Known values are: “Unknown”, “Creating”, “Created”, “Activating”, “Enabling”, “Active”, “Disabling”, “Disabled”, “SoftDeleting”, “SoftDeleted”, “Removing”, “Removed”, and “Failed”.

  • provisioning_state (str) – Provisioning state 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.

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

  • enabled (bool) – Specifies whether this instance is enabled.

Keyword Arguments:

  • location (str) – Namespace location. Required.

  • sku (Sku) – SKU parameters supplied to the create Namespace operation.

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

  • status (str or NamespaceState) – State of the Namespace. Known values are: “Unknown”, “Creating”, “Created”, “Activating”, “Enabling”, “Active”, “Disabling”, “Disabled”, “SoftDeleting”, “SoftDeleted”, “Removing”, “Removed”, and “Failed”.

  • provisioning_state (str) – Provisioning state 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.

  • enabled (bool) – Specifies whether this instance is enabled.

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

Bases: Model

The response of the List Namespace operation.

Variables:

  • value (list[NamespaceResource]) – 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[NamespaceResource]) – 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.v2015_08_01.models.NamespaceResource(*, location: str | None = None, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, status: str | _models.NamespaceState | None = None, provisioning_state: str | None = None, created_at: datetime | None = None, updated_at: datetime | None = None, service_bus_endpoint: str | None = None, enabled: bool | 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) – Resource Id.

  • name (str) – Resource name.

  • location (str) – Resource location.

  • type (str) – Resource type.

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

  • sku (Sku) – SKU parameters supplied to the create Namespace operation.

  • status (str or NamespaceState) – State of the Namespace. Known values are: “Unknown”, “Creating”, “Created”, “Activating”, “Enabling”, “Active”, “Disabling”, “Disabled”, “SoftDeleting”, “SoftDeleted”, “Removing”, “Removed”, and “Failed”.

  • provisioning_state (str) – Provisioning state 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.

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

  • enabled (bool) – Specifies whether this instance is enabled.

Keyword Arguments:

  • location (str) – Resource location.

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

  • sku (Sku) – SKU parameters supplied to the create Namespace operation.

  • status (str or NamespaceState) – State of the Namespace. Known values are: “Unknown”, “Creating”, “Created”, “Activating”, “Enabling”, “Active”, “Disabling”, “Disabled”, “SoftDeleting”, “SoftDeleted”, “Removing”, “Removed”, and “Failed”.

  • provisioning_state (str) – Provisioning state 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.

  • enabled (bool) – Specifies whether this instance is enabled.

class azure.mgmt.eventhub.v2015_08_01.models.NamespaceState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

State of the Namespace.

ACTIVATING = 'Activating'
ACTIVE = 'Active'
CREATED = 'Created'
CREATING = 'Creating'
DISABLED = 'Disabled'
DISABLING = 'Disabling'
ENABLING = 'Enabling'
FAILED = 'Failed'
REMOVED = 'Removed'
REMOVING = 'Removing'
SOFT_DELETED = 'SoftDeleted'
SOFT_DELETING = 'SoftDeleting'
UNKNOWN = 'Unknown'
class azure.mgmt.eventhub.v2015_08_01.models.NamespaceUpdateParameter(*, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, **kwargs: Any)[source]

Bases: Model

Parameters supplied to the Patch/update Namespace operation.

Variables:

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

  • sku (Sku) – The sku of the created Namespace.

Keyword Arguments:

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

  • sku (Sku) – The sku of the created Namespace.

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

Bases: str, Enum

Key that needs to be regenerated.

PRIMARY_KEY = 'PrimaryKey'
SECONDARY_KEY = 'SecondaryKey'
class azure.mgmt.eventhub.v2015_08_01.models.RegenerateKeysParameters(*, policykey: str | _models.Policykey | None = None, **kwargs: Any)[source]

Bases: Model

Parameters supplied to the Regenerate Authorization Rule keys operation.

Variables:

policykey (str or Policykey) – Key that needs to be regenerated. Known values are: “PrimaryKey” and “SecondaryKey”.

Keyword Arguments:

policykey (str or Policykey) – Key that needs to be regenerated. Known values are: “PrimaryKey” and “SecondaryKey”.

class azure.mgmt.eventhub.v2015_08_01.models.Resource(*, location: str | None = None, **kwargs: Any)[source]

Bases: Model

The Resource definition.

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

Variables:

  • id (str) – Resource Id.

  • name (str) – Resource name.

  • location (str) – Resource location.

  • type (str) – Resource type.

Keyword Arguments:

location (str) – Resource location.

class azure.mgmt.eventhub.v2015_08_01.models.ResourceListKeys(**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.

  • 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.v2015_08_01.models.SharedAccessAuthorizationRuleCreateOrUpdateParameters(*, location: str | None = None, name: str | None = None, rights: List[str | _models.AccessRights] | None = None, **kwargs: Any)[source]

Bases: Model

Parameters supplied to the Create Or Update Authorization Rules operation.

Variables:

  • location (str) – Data center location.

  • name (str) – Name of the AuthorizationRule.

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

Keyword Arguments:

  • location (str) – Data center location.

  • name (str) – Name of the AuthorizationRule.

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

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

Bases: Model

The response from the List Namespace operation.

Variables:

  • value (list[SharedAccessAuthorizationRuleResource]) – 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[SharedAccessAuthorizationRuleResource]) – 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.v2015_08_01.models.SharedAccessAuthorizationRuleResource(*, location: str | None = None, 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) – Resource Id.

  • name (str) – Resource name.

  • location (str) – Resource location.

  • type (str) – Resource type.

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

Keyword Arguments:

  • location (str) – Resource location.

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

class azure.mgmt.eventhub.v2015_08_01.models.Sku(*, tier: str | _models.SkuTier, name: str | _models.SkuName | 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. Known values are: “Basic” and “Standard”.

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

  • capacity (int) – The Event Hubs throughput units.

Keyword Arguments:

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

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

  • capacity (int) – The Event Hubs throughput units.

class azure.mgmt.eventhub.v2015_08_01.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'
STANDARD = 'Standard'
class azure.mgmt.eventhub.v2015_08_01.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.v2015_08_01.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) – Resource Id.

  • name (str) – Resource name.

  • location (str) – Resource location.

  • type (str) – Resource type.

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

Keyword Arguments:

  • location (str) – Resource location.

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

class azure.mgmt.eventhub.v2015_08_01.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'