azure.mgmt.eventhub.models module

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

Bases: msrest.serialization.Model

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.Sku(tier, name=None, capacity=None)[source]

Bases: msrest.serialization.Model

SKU of the namespace.

Parameters:
  • name (str or SkuName) – Name of this SKU. Possible values include: ‘Basic’, ‘Standard’, ‘Premium’
  • tier (str or SkuTier) – The billing tier of this particular SKU. Possible values include: ‘Basic’, ‘Standard’, ‘Premium’
  • capacity (int) – The Event Hubs throughput units.
class azure.mgmt.eventhub.models.NamespaceCreateOrUpdateParameters(location, sku=None, tags=None, provisioning_state=None, status=None, created_at=None, updated_at=None, service_bus_endpoint=None, create_acs_namespace=None, enabled=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Create Or Update Namespace operation.

Parameters:
  • location (str) – Namespace location.
  • sku (Sku) –
  • tags (dict) – Namespace tags.
  • provisioning_state (str) – Provisioning state of the namespace.
  • status (str or NamespaceState) – State of the namespace. Possible values include: ‘Unknown’, ‘Creating’, ‘Created’, ‘Activating’, ‘Enabling’, ‘Active’, ‘Disabling’, ‘Disabled’, ‘SoftDeleting’, ‘SoftDeleted’, ‘Removing’, ‘Removed’, ‘Failed’
  • 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.
  • create_acs_namespace (bool) – Indicates whether to create an ACS namespace.
  • enabled (bool) – Specifies whether this instance is enabled.
class azure.mgmt.eventhub.models.NamespaceResource(location, tags=None, sku=None, provisioning_state=None, status=None, created_at=None, updated_at=None, service_bus_endpoint=None, create_acs_namespace=None, enabled=None)[source]

Bases: azure.mgmt.eventhub.models.resource.Resource

Description of a namespace 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
  • sku (Sku) –
  • provisioning_state (str) – Provisioning state of the namespace.
  • status (str or NamespaceState) – State of the namespace. Possible values include: ‘Unknown’, ‘Creating’, ‘Created’, ‘Activating’, ‘Enabling’, ‘Active’, ‘Disabling’, ‘Disabled’, ‘SoftDeleting’, ‘SoftDeleted’, ‘Removing’, ‘Removed’, ‘Failed’
  • 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.
  • create_acs_namespace (bool) – Indicates whether to create an ACS namespace.
  • enabled (bool) – Specifies whether this instance is enabled.
class azure.mgmt.eventhub.models.SharedAccessAuthorizationRuleCreateOrUpdateParameters(rights, location=None, name=None)[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 authorization rule.
  • rights (list of str or AccessRights) – The rights associated with the rule.
class azure.mgmt.eventhub.models.SharedAccessAuthorizationRuleResource(location, rights, tags=None)[source]

Bases: azure.mgmt.eventhub.models.resource.Resource

Description of a namespace authorization rule.

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
  • rights (list of str or AccessRights) – The rights associated with the rule.
class azure.mgmt.eventhub.models.ResourceListKeys(primary_connection_string=None, secondary_connection_string=None, primary_key=None, secondary_key=None, key_name=None)[source]

Bases: msrest.serialization.Model

Namespace/EventHub Connection String.

Parameters:
  • primary_connection_string (str) – Primary connection string of the created namespace authorization rule.
  • secondary_connection_string (str) – Secondary connection string of the created namespace authorization rule.
  • 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 authorization rule.
class azure.mgmt.eventhub.models.RegenerateKeysParameters(policykey=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Regenerate Authorization Rule operation.

Parameters:policykey (str or Policykey) – Key that needs to be regenerated. Possible values include: ‘PrimaryKey’, ‘SecondaryKey’
class azure.mgmt.eventhub.models.EventHubCreateOrUpdateParameters(location, type=None, name=None, created_at=None, message_retention_in_days=None, partition_count=None, partition_ids=None, status=None, updated_at=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Create Or Update Event Hub operation.

Parameters:
  • location (str) – Location of the resource.
  • 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 (long) – Number of days to retain the events for this Event Hub.
  • partition_count (long) – Number of partitions created for the Event Hub.
  • partition_ids (list of str) – Current number of shards on 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’
  • updated_at (datetime) – The exact time the message was updated.
class azure.mgmt.eventhub.models.EventHubResource(location, tags=None, created_at=None, message_retention_in_days=None, partition_count=None, partition_ids=None, status=None, updated_at=None)[source]

Bases: azure.mgmt.eventhub.models.resource.Resource

Description of the Event Hub 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
  • created_at (datetime) – Exact time the Event Hub was created.
  • 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.
  • partition_ids (list of str) – Current number of shards on 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’
  • updated_at (datetime) – The exact time the message was updated.
class azure.mgmt.eventhub.models.ConsumerGroupCreateOrUpdateParameters(location, type=None, name=None, created_at=None, event_hub_path=None, updated_at=None, user_metadata=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Create Or Update Consumer Group operation.

Parameters:
  • location (str) – Location of the resource.
  • 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.
class azure.mgmt.eventhub.models.ConsumerGroupResource(location, tags=None, created_at=None, event_hub_path=None, updated_at=None, user_metadata=None)[source]

Bases: azure.mgmt.eventhub.models.resource.Resource

Description of the consumer group 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
  • 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.
class azure.mgmt.eventhub.models.NamespaceResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of NamespaceResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SharedAccessAuthorizationRuleResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of EventHubResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ConsumerGroupResource object

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

basic = 'Basic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.eventhub.models.NamespaceState[source]

Bases: enum.Enum

An enumeration.

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.models.AccessRights[source]

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

active = 'Active'
creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
receive_disabled = 'ReceiveDisabled'
renaming = 'Renaming'
restoring = 'Restoring'
send_disabled = 'SendDisabled'
unknown = 'Unknown'