azure.mgmt.eventhub.v2015_08_01.models module

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: bool = None, reason=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: str = None, name: str = None, user_metadata: 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.ConsumerGroupResource(*, location: str = None, user_metadata: 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.EventHubCreateOrUpdateParameters(*, location: str, type: str = None, name: str = None, message_retention_in_days: int = None, partition_count: int = None, status=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.EventHubResource(*, location: str = None, message_retention_in_days: int = None, partition_count: int = None, status=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=None, tags=None, status=None, provisioning_state: str = None, created_at=None, updated_at=None, service_bus_endpoint: str = None, enabled: 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) –
  • tags (dict[str, str]) – 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.NamespaceResource(*, location: str = None, tags=None, sku=None, status=None, provisioning_state: str = None, created_at=None, updated_at=None, service_bus_endpoint: str = None, enabled: 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]) – Resource tags
  • sku (Sku) –
  • 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.NamespaceUpdateParameter(*, tags=None, sku=None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Patch/update Namespace operation.

Parameters:
  • tags (dict[str, str]) – Resource tags
  • sku (Sku) – The sku of the created Namespace
class azure.mgmt.eventhub.v2015_08_01.models.Operation(*, display=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.RegenerateKeysParameters(*, 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: 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:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
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(*, rights, location: str = None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Create Or Update Authorization Rules operation.

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

Parameters:
  • location (str) – Data center location.
  • name (str) – Name of the AuthorizationRule.
  • rights (list[str or AccessRights]) – Required. The rights associated with the rule.
class azure.mgmt.eventhub.v2015_08_01.models.SharedAccessAuthorizationRuleResource(*, rights, location: str = 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.

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

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
Parameters:
  • location (str) – Resource location
  • rights (list[str or AccessRights]) – Required. The rights associated with the rule.
class azure.mgmt.eventhub.v2015_08_01.models.Sku(*, tier, name=None, capacity: 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.TrackedResource(*, location: str = None, tags=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:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
Parameters:
  • location (str) – Resource location
  • tags (dict[str, str]) – Resource tags
class azure.mgmt.eventhub.v2015_08_01.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of NamespaceResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SharedAccessAuthorizationRuleResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of EventHubResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ConsumerGroupResource object

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, 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.v2015_08_01.models.AccessRights[source]

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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