azure.mgmt.eventhub.v2018_01_01_preview.models module¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.AccessKeys(**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.
alias_primary_connection_string (str) – Primary connection string of the alias if GEO DR is enabled.
alias_secondary_connection_string (str) – Secondary connection string of the alias if GEO DR is enabled.
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.v2018_01_01_preview.models.AccessRights(value)[source]¶

Bases: str, enum.Enum

An enumeration.

LISTEN = 'Listen'¶

MANAGE = 'Manage'¶

SEND = 'Send'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.ArmDisasterRecovery(*, partner_namespace: Optional[str] = None, alternate_name: Optional[str] = None, **kwargs)[source]¶

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

Single item in List or Get Alias(Disaster Recovery configuration) 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 or ProvisioningStateDR) – Provisioning state of the Alias(Disaster Recovery configuration) - possible values ‘Accepted’ or ‘Succeeded’ or ‘Failed’. Possible values include: “Accepted”, “Succeeded”, “Failed”.
role (str or RoleDisasterRecovery) – role of namespace in GEO DR - possible values ‘Primary’ or ‘PrimaryNotReplicating’ or ‘Secondary’. Possible values include: “Primary”, “PrimaryNotReplicating”, “Secondary”.
pending_replication_operations_count (long) – Number of entities pending to be replicated.

Parameters

partner_namespace (str) – ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing.
alternate_name (str) – Alternate name specified when alias and namespace names are same.

class azure.mgmt.eventhub.v2018_01_01_preview.models.ArmDisasterRecoveryListResult(*, value: Optional[List[ArmDisasterRecovery]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result of the List Alias(Disaster Recovery configuration) operation.

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

Parameters: value (list[ArmDisasterRecovery]) – List of Alias(Disaster Recovery configurations).
Variables: next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration).

class azure.mgmt.eventhub.v2018_01_01_preview.models.AuthorizationRule(*, rights: Optional[List[Union[str, AccessRights]]] = None, **kwargs)[source]¶

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

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

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

class azure.mgmt.eventhub.v2018_01_01_preview.models.AuthorizationRuleListResult(*, value: Optional[List[AuthorizationRule]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response from the List namespace operation.

Parameters

value (list[AuthorizationRule]) – 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.v2018_01_01_preview.models.AvailableCluster(*, location: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Pre-provisioned and readily available Event Hubs Cluster count per region.

Parameters: location (str) – Location fo the Available Cluster.

class azure.mgmt.eventhub.v2018_01_01_preview.models.AvailableClustersList(*, value: Optional[List[AvailableCluster]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response of the List Available Clusters operation.

Parameters: value (list[AvailableCluster]) – The count of readily available and pre-provisioned Event Hubs Clusters per region.

class azure.mgmt.eventhub.v2018_01_01_preview.models.CaptureDescription(*, enabled: Optional[bool] = None, encoding: Optional[Union[str, EncodingCaptureDescription]] = None, interval_in_seconds: Optional[int] = None, size_limit_in_bytes: Optional[int] = None, destination: Optional[Destination] = None, skip_empty_archives: Optional[bool] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties to configure capture description for eventhub.

Parameters

enabled (bool) – A value that indicates whether capture description is enabled.
encoding (str or EncodingCaptureDescription) – Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version. Possible values include: “Avro”, “AvroDeflate”.
interval_in_seconds (int) – The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds.
size_limit_in_bytes (int) – The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.
destination (Destination) – Properties of Destination where capture will be stored. (Storage Account, Blob Names).
skip_empty_archives (bool) – A value that indicates whether to Skip Empty Archives.

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

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.v2018_01_01_preview.models.Cluster(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[ClusterSku] = None, **kwargs)[source]¶

Bases: azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.TrackedResource

Single Event Hubs Cluster resource in List or Get operations.

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 (str) – The UTC time when the Event Hubs Cluster was created.
updated_at (str) – The UTC time when the Event Hubs Cluster was last updated.
metric_id (str) – The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
status (str) – Status of the Cluster resource.

Parameters

location (str) – Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
sku (ClusterSku) – Properties of the cluster SKU.

class azure.mgmt.eventhub.v2018_01_01_preview.models.ClusterListResult(*, value: Optional[List[Cluster]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response of the List Event Hubs Clusters operation.

Parameters

value (list[Cluster]) – The Event Hubs Clusters present in the List Event Hubs operation results.
next_link (str) – Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters.

class azure.mgmt.eventhub.v2018_01_01_preview.models.ClusterQuotaConfigurationProperties(*, settings: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains all settings for the cluster.

Parameters: settings (dict[str, str]) – All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster.

class azure.mgmt.eventhub.v2018_01_01_preview.models.ClusterSku(*, name: Union[str, ClusterSkuName], capacity: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SKU parameters particular to a cluster instance.

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

Parameters

name (str or ClusterSkuName) – Required. Name of this SKU. Possible values include: “Dedicated”.
capacity (int) – The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

class azure.mgmt.eventhub.v2018_01_01_preview.models.ClusterSkuName(value)[source]¶

Bases: str, enum.Enum

Name of this SKU.

DEDICATED = 'Dedicated'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.ConnectionState(*, status: Optional[Union[str, PrivateLinkConnectionStatus]] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ConnectionState information.

Parameters

status (str or PrivateLinkConnectionStatus) – Status of the connection. Possible values include: “Pending”, “Approved”, “Rejected”, “Disconnected”.
description (str) – Description of the connection state.

class azure.mgmt.eventhub.v2018_01_01_preview.models.ConsumerGroup(*, user_metadata: Optional[str] = None, **kwargs)[source]¶

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

Parameters

user_metadata (str) – User Metadata 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.v2018_01_01_preview.models.ConsumerGroupListResult(*, value: Optional[List[ConsumerGroup]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result to the List Consumer Group operation.

Parameters

value (list[ConsumerGroup]) – 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.v2018_01_01_preview.models.DefaultAction(value)[source]¶

Bases: str, enum.Enum

Default Action for Network Rule Set

ALLOW = 'Allow'¶

DENY = 'Deny'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.Destination(*, name: Optional[str] = None, storage_account_resource_id: Optional[str] = None, blob_container: Optional[str] = None, archive_name_format: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Capture storage details for capture description.

Parameters

name (str) – Name for capture destination.
storage_account_resource_id (str) – Resource id of the storage account to be used to create the blobs.
blob_container (str) – Blob container Name.
archive_name_format (str) – Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order.

class azure.mgmt.eventhub.v2018_01_01_preview.models.EHNamespace(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, identity: Optional[Identity] = None, cluster_arm_id: Optional[str] = None, is_auto_inflate_enabled: Optional[bool] = None, maximum_throughput_units: Optional[int] = None, kafka_enabled: Optional[bool] = None, zone_redundant: Optional[bool] = None, encryption: Optional[Encryption] = None, **kwargs)[source]¶

Bases: azure.mgmt.eventhub.v2018_01_01_preview.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.
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[str, str]) – A set of tags. Resource tags.
sku (Sku) – Properties of sku resource.
identity (Identity) – Properties of BYOK Identity description.
cluster_arm_id (str) – Cluster ARM ID of the Namespace.
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, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true).
kafka_enabled (bool) – Value that indicates whether Kafka is enabled for eventhub namespace.
zone_redundant (bool) – Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.
encryption (Encryption) – Properties of BYOK Encryption description.

class azure.mgmt.eventhub.v2018_01_01_preview.models.EHNamespaceIdContainer(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The full ARM ID of an Event Hubs Namespace.

Parameters: id (str) – id parameter.

class azure.mgmt.eventhub.v2018_01_01_preview.models.EHNamespaceIdListResult(*, value: Optional[List[EHNamespaceIdContainer]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response of the List Namespace IDs operation.

Parameters: value (list[EHNamespaceIdContainer]) – Result of the List Namespace IDs operation.

class azure.mgmt.eventhub.v2018_01_01_preview.models.EHNamespaceListResult(*, value: Optional[List[EHNamespace]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response of the List Namespace operation.

Parameters

value (list[EHNamespace]) – 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.v2018_01_01_preview.models.EncodingCaptureDescription(value)[source]¶

Bases: str, enum.Enum

Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version

AVRO = 'Avro'¶

AVRO_DEFLATE = 'AvroDeflate'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.Encryption(*, key_vault_properties: Optional[List[KeyVaultProperties]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties to configure Encryption.

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

Parameters: key_vault_properties (list[KeyVaultProperties]) – Properties of KeyVault.
Variables: key_source (str) – Enumerates the possible value of keySource for Encryption. Default value: “Microsoft.KeyVault”.

key_source = 'Microsoft.KeyVault'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.EndPointProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning state of the Private Endpoint Connection.

CANCELED = 'Canceled'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.eventhub.v2018_01_01_preview.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.v2018_01_01_preview.models.ErrorResponse(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Error response indicates Event Hub 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.

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

Bases: msrest.serialization.Model

The result of the List EventHubs operation.

Parameters

value (list[Eventhub]) – 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.v2018_01_01_preview.models.Eventhub(*, message_retention_in_days: Optional[int] = None, partition_count: Optional[int] = None, status: Optional[Union[str, EntityStatus]] = None, capture_description: Optional[CaptureDescription] = None, **kwargs)[source]¶

Bases: azure.mgmt.eventhub.v2018_01_01_preview.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.
partition_ids (list[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”.
capture_description (CaptureDescription) – Properties of capture description.

class azure.mgmt.eventhub.v2018_01_01_preview.models.IPAction(value)[source]¶

Bases: str, enum.Enum

The IP Filter Action

ACCEPT = 'Accept'¶

REJECT = 'Reject'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.Identity(*, principal_id: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties to configure Identity for Bring your Own Keys.

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

Parameters

principal_id (str) – ObjectId from the KeyVault.
tenant_id (str) – TenantId from the KeyVault.

Variables

type (str) – Enumerates the possible value Identity type, which currently supports only ‘SystemAssigned’. Default value: “SystemAssigned”.

type = 'SystemAssigned'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.IpFilterRule(*, ip_mask: Optional[str] = None, action: Optional[Union[str, IPAction]] = None, filter_name: Optional[str] = None, **kwargs)[source]¶

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

Single item in a List or Get IpFilterRules 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.

Parameters

ip_mask (str) – IP Mask.
action (str or IPAction) – The IP Filter Action. Possible values include: “Accept”, “Reject”.
filter_name (str) – IP Filter name.

class azure.mgmt.eventhub.v2018_01_01_preview.models.IpFilterRuleListResult(*, value: Optional[List[IpFilterRule]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response from the List namespace operation.

Parameters

value (list[IpFilterRule]) – Result of the List IpFilter Rules operation.
next_link (str) – Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules.

class azure.mgmt.eventhub.v2018_01_01_preview.models.KeyType(value)[source]¶

Bases: str, enum.Enum

The access key to regenerate.

PRIMARY_KEY = 'PrimaryKey'¶

SECONDARY_KEY = 'SecondaryKey'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.KeyVaultProperties(*, key_name: Optional[str] = None, key_vault_uri: Optional[str] = None, key_version: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties to configure keyVault Properties.

Parameters

key_name (str) – Name of the Key from KeyVault.
key_vault_uri (str) – Uri of KeyVault.
key_version (str) – Key Version.

class azure.mgmt.eventhub.v2018_01_01_preview.models.MessagingRegions(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, properties: Optional[MessagingRegionsProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.TrackedResource

Messaging Region.

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]) – A set of tags. Resource tags.
properties (MessagingRegionsProperties) – Properties of Messaging Region.

class azure.mgmt.eventhub.v2018_01_01_preview.models.MessagingRegionsListResult(*, value: Optional[List[MessagingRegions]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response of the List MessagingRegions operation.

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

Parameters: value (list[MessagingRegions]) – Result of the List MessagingRegions type.
Variables: next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of MessagingRegions.

class azure.mgmt.eventhub.v2018_01_01_preview.models.MessagingRegionsProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of Messaging Region.

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

Variables

code (str) – Region code.
full_name (str) – Full name of the region.

class azure.mgmt.eventhub.v2018_01_01_preview.models.NWRuleSetIpRules(*, ip_mask: Optional[str] = None, action: Optional[Union[str, NetworkRuleIPAction]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response from the List namespace operation.

Parameters

ip_mask (str) – IP Mask.
action (str or NetworkRuleIPAction) – The IP Filter Action. Possible values include: “Allow”.

class azure.mgmt.eventhub.v2018_01_01_preview.models.NWRuleSetVirtualNetworkRules(*, subnet: Optional[Subnet] = None, ignore_missing_vnet_service_endpoint: Optional[bool] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response from the List namespace operation.

Parameters

subnet (Subnet) – Subnet properties.
ignore_missing_vnet_service_endpoint (bool) – Value that indicates whether to ignore missing Vnet Service Endpoint.

class azure.mgmt.eventhub.v2018_01_01_preview.models.NetworkRuleIPAction(value)[source]¶

Bases: str, enum.Enum

The IP Filter Action

ALLOW = 'Allow'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.NetworkRuleSet(*, trusted_service_access_enabled: Optional[bool] = None, default_action: Optional[Union[str, DefaultAction]] = None, virtual_network_rules: Optional[List[NWRuleSetVirtualNetworkRules]] = None, ip_rules: Optional[List[NWRuleSetIpRules]] = None, **kwargs)[source]¶

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

Description of topic 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

trusted_service_access_enabled (bool) – Value that indicates whether Trusted Service Access is Enabled or not.
default_action (str or DefaultAction) – Default Action for Network Rule Set. Possible values include: “Allow”, “Deny”.
virtual_network_rules (list[NWRuleSetVirtualNetworkRules]) – List VirtualNetwork Rules.
ip_rules (list[NWRuleSetIpRules]) – List of IpRules.

class azure.mgmt.eventhub.v2018_01_01_preview.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.v2018_01_01_preview.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.v2018_01_01_preview.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.v2018_01_01_preview.models.PrivateEndpoint(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

PrivateEndpoint information.

Parameters: id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.eventhub.v2018_01_01_preview.models.PrivateEndpointConnection(*, private_endpoint: Optional[PrivateEndpoint] = None, private_link_service_connection_state: Optional[ConnectionState] = None, provisioning_state: Optional[Union[str, EndPointProvisioningState]] = None, **kwargs)[source]¶

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

Properties of the PrivateEndpointConnection.

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

private_endpoint (PrivateEndpoint) – The Private Endpoint resource for this Connection.
private_link_service_connection_state (ConnectionState) – Details about the state of the connection.
provisioning_state (str or EndPointProvisioningState) – Provisioning state of the Private Endpoint Connection. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, “Failed”.

class azure.mgmt.eventhub.v2018_01_01_preview.models.PrivateEndpointConnectionListResult(*, value: Optional[List[PrivateEndpointConnection]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Result of the list of all private endpoint connections operation.

Parameters

value (list[PrivateEndpointConnection]) – A collection of private endpoint connection resources.
next_link (str) – A link for the next page of private endpoint connection resources.

class azure.mgmt.eventhub.v2018_01_01_preview.models.PrivateLinkConnectionStatus(value)[source]¶

Bases: str, enum.Enum

Status of the connection.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.PrivateLinkResource(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, group_id: Optional[str] = None, required_members: Optional[List[str]] = None, required_zone_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Information of the private link resource.

Parameters

id (str) – Fully qualified identifier of the resource.
name (str) – Name of the resource.
type (str) – Type of the resource.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.eventhub.v2018_01_01_preview.models.PrivateLinkResourcesListResult(*, value: Optional[List[PrivateLinkResource]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Result of the List private link resources operation.

Parameters

value (list[PrivateLinkResource]) – A collection of private link resources.
next_link (str) – A link for the next page of private link resources.

class azure.mgmt.eventhub.v2018_01_01_preview.models.ProvisioningStateDR(value)[source]¶

Bases: str, enum.Enum

Provisioning state of the Alias(Disaster Recovery configuration) - possible values ‘Accepted’ or ‘Succeeded’ or ‘Failed’

ACCEPTED = 'Accepted'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.RegenerateAccessKeyParameters(*, key_type: Union[str, KeyType], key: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

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

Parameters

key_type (str or KeyType) – Required. 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.v2018_01_01_preview.models.Resource(**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.

class azure.mgmt.eventhub.v2018_01_01_preview.models.RoleDisasterRecovery(value)[source]¶

Bases: str, enum.Enum

role of namespace in GEO DR - possible values ‘Primary’ or ‘PrimaryNotReplicating’ or ‘Secondary’

PRIMARY = 'Primary'¶

PRIMARY_NOT_REPLICATING = 'PrimaryNotReplicating'¶

SECONDARY = 'Secondary'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.Sku(*, name: Union[str, SkuName], tier: Optional[Union[str, SkuTier]] = 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) – Required. 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, value should be 0 to 20 throughput units.

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

Bases: str, enum.Enum

Name of this SKU.

BASIC = 'Basic'¶

STANDARD = 'Standard'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.SkuTier(value)[source]¶

Bases: str, enum.Enum

The billing tier of this particular SKU.

BASIC = 'Basic'¶

STANDARD = 'Standard'¶

class azure.mgmt.eventhub.v2018_01_01_preview.models.Subnet(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties supplied for Subnet.

Parameters: id (str) – Resource ID of Virtual Network Subnet.

class azure.mgmt.eventhub.v2018_01_01_preview.models.TrackedResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.eventhub.v2018_01_01_preview.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]) – A set of tags. Resource tags.

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

class azure.mgmt.eventhub.v2018_01_01_preview.models.VirtualNetworkRule(*, virtual_network_subnet_id: Optional[str] = None, **kwargs)[source]¶

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

Single item in a List or Get VirtualNetworkRules 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.

Parameters

virtual_network_subnet_id (str) – ARM ID of Virtual Network Subnet.

class azure.mgmt.eventhub.v2018_01_01_preview.models.VirtualNetworkRuleListResult(*, value: Optional[List[VirtualNetworkRule]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response from the List namespace operation.

Parameters

value (list[VirtualNetworkRule]) – Result of the List VirtualNetwork Rules operation.
next_link (str) – Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules.