Skip to content

Commit 037d406

Browse files
author
docsreference@microsoft.com
committed
CI Update
 Build.Reason:Manual by azure-sdk-internal-msdocs-apidrop-connection Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=500645&view=results
1 parent bc9df60 commit 037d406

File tree

43 files changed

+634
-492
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+634
-492
lines changed

‎docs-ref-autogen/azure-core/azure.core.messaging.CloudEvent.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ constructor:
4040
- <xref:object>
4141
- name: time
4242
description: Optional. The time (in UTC) the event was generated.
43-
defaultValue: <object object at 0x000001977F57AF00>
43+
defaultValue: <object object at 0x0000023E5C276F00>
4444
types:
4545
- <xref:datetime.datetime>
4646
- name: dataschema

‎docs-ref-autogen/azure-eventhub-checkpointstoreblob-aio/azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore.yml

+78-91
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ summary: 'A CheckpointStore that uses Azure Blob Storage to store the partition
1414
1515
defined in class azure.eventhub.aio.CheckpointStore of package azure-eventhub.'
1616
constructor:
17-
syntax: BlobCheckpointStore(blob_account_url, container_name, *, credential=None,
18-
**kwargs)
17+
syntax: 'BlobCheckpointStore(blob_account_url: str, container_name: str, *, credential:
18+
AsyncTokenCredential | AzureNamedKeyCredential | AzureSasCredential | None = None,
19+
api_version: str = ''2019-07-07'', secondary_hostname: str | None = None, **kwargs:
20+
Any)'
1921
parameters:
2022
- name: blob_account_url
2123
description: The URI to the storage account.
@@ -27,29 +29,30 @@ constructor:
2729
isRequired: true
2830
types:
2931
- <xref:str>
32+
keywordOnlyParameters:
3033
- name: credential
3134
description: 'The credentials with which to authenticate. This is optional if
3235
the
3336
34-
account URL already has a SAS token. The value can be a SAS token string, an
35-
account
36-
37-
shared access key, or an instance of a TokenCredentials class from azure.identity.
37+
account URL already has a SAS token. The value can be a AzureSasCredential,
38+
an AzureNamedKeyCredential,
3839
39-
If the URL already has a SAS token, specifying an explicit credential will take
40-
priority.'
41-
isRequired: true
42-
keywordOnlyParameters:
40+
or a TokenCredential.If the URL already has a SAS token, specifying an explicit
41+
credential will take priority.'
42+
types:
43+
- <xref:azure.core.credentials_async.AsyncTokenCredential>
44+
- <xref:azure.core.credentials.AzureSasCredential>
45+
- <xref:azure.core.credentials.AzureNamedKeyCredential>
46+
- <xref:None>
4347
- name: api_version
4448
description: The Storage API version to use for requests. Default value is '2019-07-07'.
49+
defaultValue: '2019-07-07'
4550
types:
4651
- <xref:str>
4752
- name: secondary_hostname
4853
description: The hostname of the secondary endpoint.
4954
types:
5055
- <xref:str>
51-
- name: credential
52-
isRequired: true
5356
methods:
5457
- uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore.claim_ownership
5558
name: claim_ownership
@@ -61,39 +64,37 @@ methods:
6164
description: Iterable of dictionaries containing all the ownerships to claim.
6265
isRequired: true
6366
types:
64-
- <xref:typing.Iterable>[<xref:typing.Dict>[<xref:str>,<xref:typing.Any>]]
67+
- <xref:iterable>[<xref:dict>[<xref:str>,<xref:any>]]
6568
return:
66-
types:
67-
- "<xref:typing.Iterable>[<xref:typing.Dict>[<xref:str>,<xref:typing.Any>]], <xref:typing.Iterable>\
68-
\ <xref:of> <xref:dictionaries> <xref:containing> <xref:partition> <xref:ownership>\
69-
\ <xref:information>:<xref:fully_qualified_namespace> (<xref:str>): <xref:The>\
70-
\ <xref:fully> <xref:qualified> <xref:namespace> <xref:that> <xref:the> <xref:Event>\
71-
\ <xref:Hub> <xref:belongs> <xref:to.> <xref:The> <xref:format> <xref:is> <xref:like>\
72-
\ \u201C<<xref:namespace>><xref:.servicebus.windows.net>\u201D<xref:.> <xref:eventhub_name>\
73-
\ (<xref:str>): <xref:The> <xref:name> <xref:of> <xref:the> <xref:specific>\
74-
\ <xref:Event> <xref:Hub> <xref:the> <xref:checkpoint> <xref:is> <xref:associated>\
75-
\ <xref:with>, <xref:relative> <xref:to> <xref:the> <xref:Event> <xref:Hubs>\
76-
\ <xref:namespace> <xref:that> <xref:contains> <xref:it.> <xref:consumer_group>\
77-
\ (<xref:str>): <xref:The> <xref:name> <xref:of> <xref:the> <xref:consumer>\
78-
\ <xref:group> <xref:the> <xref:ownership> <xref:are> <xref:associated> <xref:with.>\
79-
\ <xref:partition_id> (<xref:str>): <xref:The> <xref:partition> <xref:ID> <xref:which>\
80-
\ <xref:the> <xref:checkpoint> <xref:is> <xref:created> <xref:for.> <xref:owner_id>\
81-
\ (<xref:str>): <xref:A> <xref:UUID> <xref:representing> <xref:the> <xref:owner>\
82-
\ <xref:attempting> <xref:to> <xref:claim> <xref:this> <xref:partition.> <xref:last_modified_time>\
83-
\ (<xref:UTC> <xref:datetime.datetime>): <xref:The> <xref:last> <xref:time>\
84-
\ <xref:this> <xref:ownership> <xref:was> <xref:claimed.> <xref:etag> (<xref:str>):\
85-
\ <xref:The> <xref:Etag> <xref:value> <xref:for> <xref:the> <xref:last> <xref:time>\
86-
\ <xref:this> <xref:ownership> <xref:was> <xref:modified.> <xref:typing.Optional>\
87-
\ <xref:depending> <xref:on> <xref:storage> <xref:implementation.>"
69+
description: "Iterable of dictionaries containing partition ownership information:\n\
70+
\n* *fully_qualified_namespace* (str): The fully qualified namespace that the\
71+
\ Event Hub belongs to. The format is like \"<namespace>.servicebus.windows.net\"\
72+
. \n\n* *eventhub_name* (str): The name of the specific Event Hub the checkpoint\
73+
\ is associated with, relative to the Event Hubs namespace that contains it.\
74+
\ \n\n* *consumer_group* (str): The name of the consumer group the ownership\
75+
\ are associated with. \n\n* *partition_id* (str): The partition ID which the\
76+
\ checkpoint is created for. \n\n* *owner_id* (str): A UUID representing the\
77+
\ owner attempting to claim this partition. \n\n* *last_modified_time* (float):\
78+
\ The last time this ownership was claimed as a timestamp. \n\n* *etag* (str):\
79+
\ The Etag value for the last time this ownership was modified. Optional depending\
80+
\ on storage implementation."
81+
types:
82+
- <xref:iterable>[<xref:dict>[<xref:str>,<xref:any>]]
8883
- uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore.close
8984
name: close
90-
summary: Close an open HTTP session and connection.
85+
summary: 'Close an open HTTP session and connection.
86+
87+
:rtype: None
88+
89+
:return: None'
9190
signature: async close() -> None
9291
- uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore.from_connection_string
9392
name: from_connection_string
9493
summary: Create BlobCheckpointStore from a storage connection string.
9594
signature: 'from_connection_string(conn_str: str, container_name: str, *, credential:
96-
Any = None, **kwargs: Any | None) -> BlobCheckpointStore'
95+
AsyncTokenCredential | AzureNamedKeyCredential | AzureSasCredential | None = None,
96+
api_version: str = ''2019-07-07'', secondary_hostname: str | None = None, **kwargs:
97+
Any) -> BlobCheckpointStore'
9798
parameters:
9899
- name: conn_str
99100
description: A connection string to an Azure Storage account.
@@ -105,39 +106,40 @@ methods:
105106
isRequired: true
106107
types:
107108
- <xref:str>
109+
keywordOnlyParameters:
108110
- name: credential
109111
description: 'The credentials with which to authenticate. This is optional if
110112
the
111113
112-
account URL already has a SAS token, or the connection string already has shared
113-
114-
access key values. The value can be a SAS token string, an account shared access
114+
account URL already has a SAS token. The value can be a AzureSasCredential,
115+
an AzureNamedKeyCredential,
115116
116-
key, or an instance of a TokenCredentials class from azure.identity.
117+
or a TokenCredential.If the URL already has a SAS token,
117118
118-
Credentials provided here will take precedence over those in the connection
119-
string.'
120-
isRequired: true
121-
keywordOnlyParameters:
119+
specifying an explicit credential will take priority.'
120+
types:
121+
- <xref:azure.core.credentials_async.AsyncTokenCredential>
122+
- <xref:azure.core.credentials.AzureSasCredential>
123+
- <xref:azure.core.credentials.AzureNamedKeyCredential>
124+
- <xref:None>
122125
- name: api_version
123126
description: The Storage API version to use for requests. Default value is '2019-07-07'.
127+
defaultValue: '2019-07-07'
124128
types:
125129
- <xref:str>
126130
- name: secondary_hostname
127131
description: The hostname of the secondary endpoint.
128132
types:
129133
- <xref:str>
130-
- name: credential
131-
isRequired: true
132134
return:
133135
description: A blob checkpoint store.
134136
types:
135137
- <xref:azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore>
136138
- uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore.list_checkpoints
137139
name: list_checkpoints
138140
summary: List the updated checkpoints from the storage blob.
139-
signature: async list_checkpoints(fully_qualified_namespace, eventhub_name, consumer_group,
140-
**kwargs)
141+
signature: 'async list_checkpoints(fully_qualified_namespace: str, eventhub_name:
142+
str, consumer_group: str, **kwargs: Any) -> Iterable[Dict[str, Any]]'
141143
parameters:
142144
- name: fully_qualified_namespace
143145
description: 'The fully qualified namespace that the Event Hub belongs to.
@@ -160,24 +162,18 @@ methods:
160162
types:
161163
- <xref:str>
162164
return:
163-
types:
164-
- "<xref:typing.Iterable>[<xref:typing.Dict>[<xref:str>,<xref:typing.Any>]], <xref:typing.Iterable>\
165-
\ <xref:of> <xref:dictionaries> <xref:containing> <xref:partition> <xref:checkpoint>\
166-
\ <xref:information>:<xref:fully_qualified_namespace> (<xref:str>): <xref:The>\
167-
\ <xref:fully> <xref:qualified> <xref:namespace> <xref:that> <xref:the> <xref:Event>\
168-
\ <xref:Hub> <xref:belongs> <xref:to.> <xref:The> <xref:format> <xref:is> <xref:like>\
169-
\ \u201C<<xref:namespace>><xref:.servicebus.windows.net>\u201D<xref:.> <xref:eventhub_name>\
170-
\ (<xref:str>): <xref:The> <xref:name> <xref:of> <xref:the> <xref:specific>\
171-
\ <xref:Event> <xref:Hub> <xref:the> <xref:checkpoints> <xref:are> <xref:associated>\
172-
\ <xref:with>, <xref:relative> <xref:to> <xref:the> <xref:Event> <xref:Hubs>\
173-
\ <xref:namespace> <xref:that> <xref:contains> <xref:it.> <xref:consumer_group>\
174-
\ (<xref:str>): <xref:The> <xref:name> <xref:of> <xref:the> <xref:consumer>\
175-
\ <xref:group> <xref:the> <xref:checkpoints> <xref:are> <xref:associated> <xref:with.>\
176-
\ <xref:partition_id> (<xref:str>): <xref:The> <xref:partition> <xref:ID> <xref:which>\
177-
\ <xref:the> <xref:checkpoint> <xref:is> <xref:created> <xref:for.> <xref:sequence_number>\
178-
\ (<xref:int>): <xref:The> <xref:sequence> <xref:number> <xref:of> <xref:the>\
179-
\ <xref:EventData.> <xref:offset> (<xref:str>): <xref:The> <xref:offset> <xref:of>\
180-
\ <xref:the> <xref:EventData.>"
165+
description: "Iterable of dictionaries containing partition checkpoint information:\n\
166+
\n* *fully_qualified_namespace* (str): The fully qualified namespace that the\
167+
\ Event Hub belongs to. The format is like \"<namespace>.servicebus.windows.net\"\
168+
. \n\n* *eventhub_name* (str): The name of the specific Event Hub the checkpoints\
169+
\ are associated with, relative to the Event Hubs namespace that contains it.\
170+
\ \n\n* *consumer_group* (str): The name of the consumer group the checkpoints\
171+
\ are associated with. \n\n* *partition_id* (str): The partition ID which the\
172+
\ checkpoint is created for. \n\n* *sequence_number* (int): The sequence number\
173+
\ of the <xref:azure.eventhub.EventData>. \n\n* *offset* (str): The offset of\
174+
\ the <xref:azure.eventhub.EventData>."
175+
types:
176+
- <xref:iterable>[<xref:dict>[<xref:str>,<xref:any>]]
181177
- uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore.list_ownership
182178
name: list_ownership
183179
summary: Retrieves a complete ownership list from the storage blob.
@@ -205,29 +201,20 @@ methods:
205201
types:
206202
- <xref:str>
207203
return:
208-
types:
209-
- "<xref:typing.Iterable>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]],\
210-
\ <xref:typing.Iterable> <xref:of> <xref:dictionaries> <xref:containing> <xref:partition>\
211-
\ <xref:ownership> <xref:information>:<xref:fully_qualified_namespace> (<xref:str>):\
212-
\ <xref:The> <xref:fully> <xref:qualified> <xref:namespace> <xref:that> <xref:the>\
213-
\ <xref:Event> <xref:Hub> <xref:belongs> <xref:to.> <xref:The> <xref:format>\
214-
\ <xref:is> <xref:like> \u201C<<xref:namespace>><xref:.servicebus.windows.net>\u201D\
215-
<xref:.> <xref:eventhub_name> (<xref:str>): <xref:The> <xref:name> <xref:of>\
216-
\ <xref:the> <xref:specific> <xref:Event> <xref:Hub> <xref:the> <xref:checkpoint>\
217-
\ <xref:is> <xref:associated> <xref:with>, <xref:relative> <xref:to> <xref:the>\
218-
\ <xref:Event> <xref:Hubs> <xref:namespace> <xref:that> <xref:contains> <xref:it.>\
219-
\ <xref:consumer_group> (<xref:str>): <xref:The> <xref:name> <xref:of> <xref:the>\
220-
\ <xref:consumer> <xref:group> <xref:the> <xref:ownership> <xref:are> <xref:associated>\
221-
\ <xref:with.> <xref:partition_id> (<xref:str>): <xref:The> <xref:partition>\
222-
\ <xref:ID> <xref:which> <xref:the> <xref:checkpoint> <xref:is> <xref:created>\
223-
\ <xref:for.> <xref:owner_id> (<xref:str>): <xref:A> <xref:UUID> <xref:representing>\
224-
\ <xref:the> <xref:current> <xref:owner> <xref:of> <xref:this> <xref:partition.>\
225-
\ <xref:last_modified_time> (<xref:UTC> <xref:datetime.datetime>): <xref:The>\
226-
\ <xref:last> <xref:time> <xref:this> <xref:ownership> <xref:was> <xref:claimed.>\
227-
\ <xref:etag> (<xref:str>): <xref:The> <xref:Etag> <xref:value> <xref:for>\
228-
\ <xref:the> <xref:last> <xref:time> <xref:this> <xref:ownership> <xref:was>\
229-
\ <xref:modified.> <xref:typing.Optional> <xref:depending> <xref:on> <xref:storage>\
230-
\ <xref:implementation.>"
204+
description: "Iterable of dictionaries containing partition ownership information:\n\
205+
\n* *fully_qualified_namespace* (str): The fully qualified namespace that the\
206+
\ Event Hub belongs to. The format is like \"<namespace>.servicebus.windows.net\"\
207+
. \n\n* *eventhub_name* (str): The name of the specific Event Hub the checkpoint\
208+
\ is associated with, relative to the Event Hubs namespace that contains it.\
209+
\ \n\n* *consumer_group* (str): The name of the consumer group the ownership\
210+
\ are associated with. \n\n* *partition_id* (str): The partition ID which the\
211+
\ checkpoint is created for. \n\n* *owner_id* (str): A UUID representing the\
212+
\ current owner of this partition. \n\n* *last_modified_time* (float): The last\
213+
\ time this ownership was claimed as a timestamp. \n\n* *etag* (str): The Etag\
214+
\ value for the last time this ownership was modified. Optional depending on\
215+
\ storage implementation."
216+
types:
217+
- <xref:iterable>[<xref:dict>[<xref:str>, <xref:any>]]
231218
- uid: azure.eventhub.extensions.checkpointstoreblobaio.BlobCheckpointStore.update_checkpoint
232219
name: update_checkpoint
233220
summary: 'Updates the checkpoint using the given information for the offset, associated
@@ -257,7 +244,7 @@ methods:
257244
\ <xref:azure.eventhub.EventData> the new checkpoint will be associated with."
258245
isRequired: true
259246
types:
260-
- <xref:typing.Dict>[<xref:str>,<xref:typing.Any>]
247+
- <xref:dict>[<xref:str>,<xref:any>]
261248
return:
262249
types:
263250
- <xref:None>

0 commit comments

Comments
 (0)