models Package
Classes
AccessKeys |
Namespace/EventHub Connection String. Variables are only populated by the server, and will be ignored when sending a request. |
ApplicationGroup |
The Application Group object. Variables are only populated by the server, and will be ignored when sending a request. |
ApplicationGroupListResult |
The response from the List Application Groups operation. Variables are only populated by the server, and will be ignored when sending a request. |
ApplicationGroupPolicy |
Properties of the Application Group policy. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ThrottlingPolicy All required parameters must be populated in order to send to Azure. |
ArmDisasterRecovery |
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. |
ArmDisasterRecoveryListResult |
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. |
AuthorizationRule |
Single item in a List or Get AuthorizationRule operation. Variables are only populated by the server, and will be ignored when sending a request. |
AuthorizationRuleListResult |
The response from the List namespace operation. |
AvailableCluster |
Pre-provisioned and readily available Event Hubs Cluster count per region. |
AvailableClustersList |
The response of the List Available Clusters operation. |
CaptureDescription |
Properties to configure capture description for eventhub. |
CheckNameAvailabilityParameter |
Parameter supplied to check Namespace name availability operation. All required parameters must be populated in order to send to Azure. |
CheckNameAvailabilityResult |
The Result of the CheckNameAvailability operation. Variables are only populated by the server, and will be ignored when sending a request. |
Cluster |
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. |
ClusterListResult |
The response of the List Event Hubs Clusters operation. |
ClusterQuotaConfigurationProperties |
Contains all settings for the cluster. |
ClusterSku |
SKU parameters particular to a cluster instance. All required parameters must be populated in order to send to Azure. |
ConnectionState |
ConnectionState information. |
ConsumerGroup |
Single item in List or Get Consumer group operation. Variables are only populated by the server, and will be ignored when sending a request. |
ConsumerGroupListResult |
The result to the List Consumer Group operation. |
Destination |
Capture storage details for capture description. |
EHNamespace |
Single Namespace item in List or Get Operation. Variables are only populated by the server, and will be ignored when sending a request. |
EHNamespaceIdContainer |
The full ARM ID of an Event Hubs Namespace. |
EHNamespaceIdListResult |
The response of the List Namespace IDs operation. |
EHNamespaceListResult |
The response of the List Namespace operation. |
Encryption |
Properties to configure Encryption. |
ErrorAdditionalInfo |
The resource management error additional info. Variables are only populated by the server, and will be ignored when sending a request. |
ErrorDetail |
The error detail. Variables are only populated by the server, and will be ignored when sending a request. |
ErrorResponse |
Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message. |
EventHubListResult |
The result of the List EventHubs operation. |
Eventhub |
Single item in List or Get Event Hub operation. Variables are only populated by the server, and will be ignored when sending a request. |
Identity |
Properties to configure Identity for Bring your Own Keys. Variables are only populated by the server, and will be ignored when sending a request. |
KeyVaultProperties |
Properties to configure keyVault Properties. |
NWRuleSetIpRules |
The response from the List namespace operation. |
NWRuleSetVirtualNetworkRules |
The response from the List namespace operation. |
NetworkRuleSet |
Description of topic resource. Variables are only populated by the server, and will be ignored when sending a request. |
NetworkRuleSetListResult |
The response of the List NetworkRuleSet operation. |
NetworkSecurityPerimeter |
NetworkSecurityPerimeter related information. |
NetworkSecurityPerimeterConfiguration |
Network Security Perimeter related configurations of a given namespace. Variables are only populated by the server, and will be ignored when sending a request. |
NetworkSecurityPerimeterConfigurationList |
Result of the List NetworkSecurityPerimeterConfiguration operation. Variables are only populated by the server, and will be ignored when sending a request. |
NetworkSecurityPerimeterConfigurationPropertiesProfile |
Information about current network profile. |
NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation |
Information about resource association. |
NspAccessRule |
Information of Access Rule in Network Profile. Variables are only populated by the server, and will be ignored when sending a request. |
NspAccessRuleProperties |
Properties of Access Rule. Variables are only populated by the server, and will be ignored when sending a request. |
NspAccessRulePropertiesSubscriptionsItem |
Subscription for inbound rule. |
Operation |
A Event Hub REST API operation. Variables are only populated by the server, and will be ignored when sending a request. |
OperationDisplay |
Operation display payload. Variables are only populated by the server, and will be ignored when sending a request. |
OperationListResult |
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. |
PrivateEndpoint |
PrivateEndpoint information. |
PrivateEndpointConnection |
Properties of the PrivateEndpointConnection. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateEndpointConnectionListResult |
Result of the list of all private endpoint connections operation. |
PrivateLinkResource |
Information of the private link resource. |
PrivateLinkResourcesListResult |
Result of the List private link resources operation. |
ProvisioningIssue |
Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration. Variables are only populated by the server, and will be ignored when sending a request. |
ProvisioningIssueProperties |
Properties of Provisioning Issue. |
ProxyResource |
Common fields that are returned in the response for all Azure Resource Manager resources. Variables are only populated by the server, and will be ignored when sending a request. |
RegenerateAccessKeyParameters |
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. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources. Variables are only populated by the server, and will be ignored when sending a request. |
SchemaGroup |
Single item in List or Get Schema Group operation. Variables are only populated by the server, and will be ignored when sending a request. |
SchemaGroupListResult |
The result of the List SchemaGroup operation. |
Sku |
SKU parameters supplied to the create namespace operation. All required parameters must be populated in order to send to Azure. |
Subnet |
Properties supplied for Subnet. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
ThrottlingPolicy |
Properties of the throttling policy. All required parameters must be populated in order to send to Azure. |
TrackedResource |
Definition of resource. Variables are only populated by the server, and will be ignored when sending a request. |
UserAssignedIdentity |
Recognized Dictionary value. Variables are only populated by the server, and will be ignored when sending a request. |
UserAssignedIdentityProperties |
UserAssignedIdentityProperties. |
Enums
AccessRights |
AccessRights. |
ApplicationGroupPolicyType |
Application Group Policy types. |
ClusterSkuName |
Name of this SKU. |
CreatedByType |
The type of identity that created the resource. |
DefaultAction |
Default Action for Network Rule Set. |
EncodingCaptureDescription |
Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version. |
EndPointProvisioningState |
Provisioning state of the Private Endpoint Connection. |
EntityStatus |
Enumerates the possible values for the status of the Event Hub. |
KeyType |
The access key to regenerate. |
ManagedServiceIdentityType |
Type of managed service identity. |
MetricId |
Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal. |
NetworkRuleIPAction |
The IP Filter Action. |
NetworkSecurityPerimeterConfigurationProvisioningState |
Provisioning state of NetworkSecurityPerimeter configuration propagation. |
NspAccessRuleDirection |
Direction of Access Rule. |
PrivateLinkConnectionStatus |
Status of the connection. |
ProvisioningStateDR |
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'. |
PublicNetworkAccess |
This determines if traffic is allowed over public network. By default it is enabled. |
PublicNetworkAccessFlag |
This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. |
ResourceAssociationAccessMode |
Access Mode of the resource association. |
RoleDisasterRecovery |
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'. |
SchemaCompatibility |
SchemaCompatibility. |
SchemaType |
SchemaType. |
SkuName |
Name of this SKU. |
SkuTier |
The billing tier of this particular SKU. |
TlsVersion |
The minimum TLS version for the cluster to support, e.g. '1.2'. |
UnavailableReason |
Specifies the reason for the unavailability of the service. |
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for