azure.mgmt.eventhub.v2015_08_01.models module

class azure.mgmt.eventhub.v2015_08_01.models.AccessRights(value)[source]

Bases: str, enum.Enum

An enumeration.

listen = 'Listen'
manage = 'Manage'
send = 'Send'
class azure.mgmt.eventhub.v2015_08_01.models.CheckNameAvailabilityParameter(*, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Parameter supplied to check Namespace name availability operation.

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

Parameters

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

class azure.mgmt.eventhub.v2015_08_01.models.CheckNameAvailabilityResult(*, name_available: Optional[bool] = None, reason: Optional[Union[str, UnavailableReason]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Result of the CheckNameAvailability operation.

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

Parameters

  • 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. Possible values include: “None”, “InvalidName”, “SubscriptionIsDisabled”, “NameInUse”, “NameInLockdown”, “TooManyNamespaceInCurrentSubscription”.

Variables

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

class azure.mgmt.eventhub.v2015_08_01.models.ConsumerGroupCreateOrUpdateParameters(*, location: str, type: Optional[str] = None, name: Optional[str] = None, user_metadata: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.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 Azure.

Parameters

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

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

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

  • user_metadata (str) – The user metadata.

Variables

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

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

Bases: msrest.serialization.Model

The result to the List Consumer Group operation.

Parameters

  • 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: Optional[str] = None, user_metadata: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.eventhub.v2015_08_01.models._models_py3.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.

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

Parameters

  • location (str) – Resource location.

  • user_metadata (str) – The user metadata.

class azure.mgmt.eventhub.v2015_08_01.models.EntityStatus(value)[source]

Bases: str, enum.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: Optional[str] = None, name: Optional[str] = None, message_retention_in_days: Optional[int] = None, partition_count: Optional[int] = None, status: Optional[Union[str, EntityStatus]] = None, **kwargs)[source]

Bases: msrest.serialization.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 Azure.

Parameters

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

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

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

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

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

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

Variables

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

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

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

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

Bases: msrest.serialization.Model

The result of the List EventHubs operation.

Parameters

  • 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: Optional[str] = None, message_retention_in_days: Optional[int] = None, partition_count: Optional[int] = None, status: Optional[Union[str, EntityStatus]] = None, **kwargs)[source]

Bases: azure.mgmt.eventhub.v2015_08_01.models._models_py3.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.

  • type (str) – Resource type.

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

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

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

Parameters

  • location (str) – Resource location.

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

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

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

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

Bases: msrest.serialization.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 Azure.

Parameters

  • location (str) – Required. Namespace location.

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

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

  • status (str or NamespaceState) – State of the Namespace. Possible values include: “Unknown”, “Creating”, “Created”, “Activating”, “Enabling”, “Active”, “Disabling”, “Disabled”, “SoftDeleting”, “SoftDeleted”, “Removing”, “Removed”, “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.

Variables

metric_id (str) – Identifier for Azure Insights metrics.

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

Bases: msrest.serialization.Model

The response of the List Namespace operation.

Parameters

  • 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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, status: Optional[Union[str, NamespaceState]] = None, provisioning_state: Optional[str] = None, created_at: Optional[datetime.datetime] = None, updated_at: Optional[datetime.datetime] = None, service_bus_endpoint: Optional[str] = None, enabled: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.eventhub.v2015_08_01.models._models_py3.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.

  • type (str) – Resource type.

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

Parameters

  • location (str) – Resource location.

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

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

  • status (str or NamespaceState) – State of the Namespace. Possible values include: “Unknown”, “Creating”, “Created”, “Activating”, “Enabling”, “Active”, “Disabling”, “Disabled”, “SoftDeleting”, “SoftDeleted”, “Removing”, “Removed”, “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)[source]

Bases: str, enum.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: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Patch/update Namespace operation.

Parameters

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

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

class azure.mgmt.eventhub.v2015_08_01.models.Operation(*, display: Optional[OperationDisplay] = None, **kwargs)[source]

Bases: msrest.serialization.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}.

Parameters

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

class azure.mgmt.eventhub.v2015_08_01.models.OperationDisplay(**kwargs)[source]

Bases: msrest.serialization.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)[source]

Bases: msrest.serialization.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)[source]

Bases: str, enum.Enum

Key that needs to be regenerated.

primary_key = 'PrimaryKey'
secondary_key = 'SecondaryKey'
class azure.mgmt.eventhub.v2015_08_01.models.RegenerateKeysParameters(*, policykey: Optional[Union[str, Policykey]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Regenerate Authorization Rule keys operation.

Parameters

policykey (str or Policykey) – Key that needs to be regenerated. Possible values include: “PrimaryKey”, “SecondaryKey”.

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

Bases: msrest.serialization.Model

The Resource definition.

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

Variables
Parameters

location (str) – Resource location.

class azure.mgmt.eventhub.v2015_08_01.models.ResourceListKeys(**kwargs)[source]

Bases: msrest.serialization.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: Optional[str] = None, name: Optional[str] = None, rights: Optional[List[Union[str, AccessRights]]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Create Or Update Authorization Rules operation.

Parameters

  • 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: Optional[List[SharedAccessAuthorizationRuleResource]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The response from the List Namespace operation.

Parameters

  • 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: Optional[str] = None, rights: Optional[List[Union[str, AccessRights]]] = None, **kwargs)[source]

Bases: azure.mgmt.eventhub.v2015_08_01.models._models_py3.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
Parameters

  • 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: Union[str, SkuTier], name: Optional[Union[str, SkuName]] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

SKU parameters supplied to the create Namespace operation.

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

Parameters

  • name (str or SkuName) – Name of this SKU. Possible values include: “Basic”, “Standard”.

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

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

class azure.mgmt.eventhub.v2015_08_01.models.SkuName(value)[source]

Bases: str, enum.Enum

Name of this SKU.

basic = 'Basic'
standard = 'Standard'
class azure.mgmt.eventhub.v2015_08_01.models.SkuTier(value)[source]

Bases: str, enum.Enum

The billing tier of this particular SKU.

basic = 'Basic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.eventhub.v2015_08_01.models.TrackedResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.eventhub.v2015_08_01.models._models_py3.Resource

Definition of Resource.

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

Variables
Parameters

  • location (str) – Resource location.

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

class azure.mgmt.eventhub.v2015_08_01.models.UnavailableReason(value)[source]

Bases: str, enum.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'