azure.mgmt.eventhub.models module

class azure.mgmt.eventhub.models.TrackedResource(location=None, tags=None)[source]

Bases: azure.mgmt.eventhub.models.resource.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) – Resource tags
class azure.mgmt.eventhub.models.Resource[source]

Bases: msrest.serialization.Model

The Resource definition.

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

Variables:
class azure.mgmt.eventhub.models.Sku(name, tier=None, capacity=None)[source]

Bases: msrest.serialization.Model

SKU parameters supplied to the create namespace operation.

Parameters:
  • name (str or SkuName) – Name of this SKU. Possible values include: ‘Basic’, ‘Standard’
  • tier (str or SkuTier) – The billing tier of this particular SKU. Possible values include: ‘Basic’, ‘Standard’
  • capacity (int) – The Event Hubs throughput units, vaule should be 0 to 20 throughput units.
class azure.mgmt.eventhub.models.EHNamespace(location=None, tags=None, sku=None, is_auto_inflate_enabled=None, maximum_throughput_units=None)[source]

Bases: azure.mgmt.eventhub.models.tracked_resource.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
  • 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.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – Properties of sku resource
  • 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, vaule should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true)
class azure.mgmt.eventhub.models.AuthorizationRule(rights=None)[source]

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

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

class azure.mgmt.eventhub.models.AccessKeys[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.models.RegenerateAccessKeyParameters(key_type, key=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • key_type (str or KeyType) – The access key to regenerate. Possible values include: ‘PrimaryKey’, ‘SecondaryKey’
  • key (str) – Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType
class azure.mgmt.eventhub.models.Eventhub(message_retention_in_days=None, partition_count=None, status=None)[source]

Bases: azure.mgmt.eventhub.models.resource.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
  • partition_ids (list of 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.
Parameters:
  • message_retention_in_days (long) – Number of days to retain the events for this Event Hub, value should be 1 to 7 days
  • partition_count (long) – 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. Possible values include: ‘Active’, ‘Disabled’, ‘Restoring’, ‘SendDisabled’, ‘ReceiveDisabled’, ‘Creating’, ‘Deleting’, ‘Renaming’, ‘Unknown’
class azure.mgmt.eventhub.models.ConsumerGroup(user_metadata=None)[source]

Bases: azure.mgmt.eventhub.models.resource.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.
  • updated_at (datetime) – The exact time the message was updated.
Parameters:

user_metadata (str) – Usermetadata 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.models.CheckNameAvailabilityParameter(name)[source]

Bases: msrest.serialization.Model

Parameter supplied to check Namespace name availability operation .

Parameters:name (str) – Name to check the namespace name availability
class azure.mgmt.eventhub.models.CheckNameAvailabilityResult(name_available=None, reason=None)[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.

Variables:

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

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’
class azure.mgmt.eventhub.models.OperationDisplay[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.models.Operation(display=None)[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.models.ErrorResponse(code=None, message=None)[source]

Bases: msrest.serialization.Model

Error reponse indicates EventHub service is not able to process the incoming request. The reason is provided in the error message.

Parameters:
  • code (str) – Error code.
  • message (str) – Error message indicating why the operation failed.
exception azure.mgmt.eventhub.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.mgmt.eventhub.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

class azure.mgmt.eventhub.models.EHNamespacePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of EHNamespace object

class azure.mgmt.eventhub.models.AuthorizationRulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AuthorizationRule object

class azure.mgmt.eventhub.models.EventhubPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Eventhub object

class azure.mgmt.eventhub.models.ConsumerGroupPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ConsumerGroup object

class azure.mgmt.eventhub.models.SkuName[source]

Bases: enum.Enum

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

Bases: enum.Enum

basic = 'Basic'
standard = 'Standard'
class azure.mgmt.eventhub.models.AccessRights[source]

Bases: enum.Enum

listen = 'Listen'
manage = 'Manage'
send = 'Send'
class azure.mgmt.eventhub.models.KeyType[source]

Bases: enum.Enum

primary_key = 'PrimaryKey'
secondary_key = 'SecondaryKey'
class azure.mgmt.eventhub.models.EntityStatus[source]

Bases: enum.Enum

active = 'Active'
creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
receive_disabled = 'ReceiveDisabled'
renaming = 'Renaming'
restoring = 'Restoring'
send_disabled = 'SendDisabled'
unknown = 'Unknown'
class azure.mgmt.eventhub.models.UnavailableReason[source]

Bases: enum.Enum

invalid_name = 'InvalidName'
name_in_lockdown = 'NameInLockdown'
name_in_use = 'NameInUse'
none = 'None'
subscription_is_disabled = 'SubscriptionIsDisabled'
too_many_namespace_in_current_subscription = 'TooManyNamespaceInCurrentSubscription'