azure.mgmt.eventhub.v2017_04_01.models module¶
-
class
azure.mgmt.eventhub.v2017_04_01.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.v2017_04_01.models.
AccessRights
(value)[source]¶ -
An enumeration.
-
listen
= 'Listen'¶
-
manage
= 'Manage'¶
-
send
= 'Send'¶
-
-
class
azure.mgmt.eventhub.v2017_04_01.models.
ArmDisasterRecovery
(*, partner_namespace: Optional[str] = None, alternate_name: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventhub.v2017_04_01.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
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
-
class
azure.mgmt.eventhub.v2017_04_01.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.v2017_04_01.models.
AuthorizationRule
(*, rights: Optional[List[Union[str, AccessRights]]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventhub.v2017_04_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.
-
class
azure.mgmt.eventhub.v2017_04_01.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.v2017_04_01.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.v2017_04_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.v2017_04_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.
- 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.v2017_04_01.models.
ConsumerGroup
(*, user_metadata: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventhub.v2017_04_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
- 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.v2017_04_01.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.v2017_04_01.models.
DefaultAction
(value)[source]¶ -
Default Action for Network Rule Set
-
allow
= 'Allow'¶
-
deny
= 'Deny'¶
-
-
class
azure.mgmt.eventhub.v2017_04_01.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.v2017_04_01.models.
EHNamespace
(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, is_auto_inflate_enabled: Optional[bool] = None, maximum_throughput_units: Optional[int] = None, kafka_enabled: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventhub.v2017_04_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
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.
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, 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.
-
class
azure.mgmt.eventhub.v2017_04_01.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.v2017_04_01.models.
EncodingCaptureDescription
(value)[source]¶ -
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.v2017_04_01.models.
EntityStatus
(value)[source]¶ -
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.v2017_04_01.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.
-
class
azure.mgmt.eventhub.v2017_04_01.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.
-
class
azure.mgmt.eventhub.v2017_04_01.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.v2017_04_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
- 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.v2017_04_01.models.
KeyType
(value)[source]¶ -
The access key to regenerate.
-
primary_key
= 'PrimaryKey'¶
-
secondary_key
= 'SecondaryKey'¶
-
-
class
azure.mgmt.eventhub.v2017_04_01.models.
MessagingPlan
(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventhub.v2017_04_01.models._models_py3.TrackedResource
Messaging Plan for the namespace.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
-
class
azure.mgmt.eventhub.v2017_04_01.models.
MessagingRegions
(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, properties: Optional[MessagingRegionsProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventhub.v2017_04_01.models._models_py3.TrackedResource
Messaging Region.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.eventhub.v2017_04_01.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.v2017_04_01.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.
-
class
azure.mgmt.eventhub.v2017_04_01.models.
NWRuleSetIpRules
(*, ip_mask: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Description of NetWorkRuleSet - IpRules resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
ip_mask (str) – IP Mask.
- Variables
action (str) – The IP Filter Action. Default value: “Allow”.
-
action
= 'Allow'¶
-
class
azure.mgmt.eventhub.v2017_04_01.models.
NWRuleSetVirtualNetworkRules
(*, subnet: Optional[Subnet] = None, ignore_missing_vnet_service_endpoint: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Description of VirtualNetworkRules - NetworkRules resource.
-
class
azure.mgmt.eventhub.v2017_04_01.models.
NetworkRuleSet
(*, 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.v2017_04_01.models._models_py3.Resource
Description of NetworkRuleSet resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
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.v2017_04_01.models.
NetworkRuleSetListResult
(*, value: Optional[List[NetworkRuleSet]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The response of the List NetworkRuleSet operation.
- Parameters
value (list[NetworkRuleSet]) – Result of the List NetworkRuleSet operation.
next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet.
-
class
azure.mgmt.eventhub.v2017_04_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.v2017_04_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.
-
class
azure.mgmt.eventhub.v2017_04_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.
-
class
azure.mgmt.eventhub.v2017_04_01.models.
ProvisioningStateDR
(value)[source]¶ -
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.v2017_04_01.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.
-
class
azure.mgmt.eventhub.v2017_04_01.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.
-
class
azure.mgmt.eventhub.v2017_04_01.models.
RoleDisasterRecovery
(value)[source]¶ -
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.v2017_04_01.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.v2017_04_01.models.
SkuName
(value)[source]¶ -
Name of this SKU.
-
basic
= 'Basic'¶
-
standard
= 'Standard'¶
-
-
class
azure.mgmt.eventhub.v2017_04_01.models.
SkuTier
(value)[source]¶ -
The billing tier of this particular SKU.
-
basic
= 'Basic'¶
-
standard
= 'Standard'¶
-
-
class
azure.mgmt.eventhub.v2017_04_01.models.
Subnet
(*, id: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties supplied for Subnet.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – Required. Resource ID of Virtual Network Subnet.
-
class
azure.mgmt.eventhub.v2017_04_01.models.
TrackedResource
(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventhub.v2017_04_01.models._models_py3.Resource
Definition of resource.
Variables are only populated by the server, and will be ignored when sending a request.