Share via

EventHubConnectionStringProperties Class

  • Reference

Properties of a connection string.

Inheritance
azure.eventhub._mixin.DictMixin
EventHubConnectionStringProperties

Constructor

EventHubConnectionStringProperties(*, fully_qualified_namespace: str, endpoint: str, eventhub_name: str | None = None, shared_access_signature: str | None = None, shared_access_key_name: str | None = None, shared_access_key: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
fully_qualified_namespace
Required
endpoint
Required
eventhub_name
Required
shared_access_signature
Required
shared_access_key_name
Required
shared_access_key
Required

Methods

get
has_key
items
keys
update
values

get 

get(key: str, default: Any | None = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k: str) -> bool

Parameters

Name Description
k
Required

items 

items() -> List[Tuple[str, Any]]

keys 

keys() -> List[str]

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> List[Any]

Attributes

endpoint

///

Returns

Type Description
str

eventhub_name

Optional. The name of the Event Hub, represented by EntityPath in the connection string.

Returns

Type Description
str

fully_qualified_namespace

The fully qualified host name for the Event Hubs namespace. The namespace format is: .servicebus.windows.net.

Returns

Type Description
str

shared_access_key

The shared_access_key can be used along with the shared_access_key_name as a credential.

Returns

Type Description
str

shared_access_key_name

The name of the shared_access_key. This must be used along with the shared_access_key.

Returns

Type Description
str

shared_access_signature

This can be provided instead of the shared_access_key_name and the shared_access_key.

Returns

Type Description
str