Skip to content

Commit 8373983

Browse files
author
apexvss@microsoft.com
committed
1 parent 619142b commit 8373983

10 files changed

+58
-33
lines changed

docs-ref-autogen/azure-communication-sms/azure.communication.sms.SmsClient.yml

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,19 @@ summary: 'A client to interact with the AzureCommunicationService Sms gateway.
1010
1111
This client provides operations to send an SMS via a phone number.'
1212
constructor:
13-
syntax: 'SmsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)'
13+
syntax: 'SmsClient(endpoint: str, credential: TokenCredential | AzureKeyCredential,
14+
**kwargs: Any)'
1415
parameters:
1516
- name: endpoint
1617
description: The endpoint url for Azure Communication Service resource.
1718
isRequired: true
1819
types:
1920
- <xref:str>
2021
- name: credential
21-
description: The TokenCredential we use to authenticate against the service.
22+
description: The credential we use to authenticate against the service.
2223
isRequired: true
2324
types:
24-
- <xref:TokenCredential>
25+
- <xref:typing.Union>[<xref:TokenCredential>, <xref:AzureKeyCredential>]
2526
methods:
2627
- uid: azure.communication.sms.SmsClient.from_connection_string
2728
name: from_connection_string
@@ -36,12 +37,22 @@ methods:
3637
return:
3738
description: Instance of SmsClient.
3839
types:
39-
- <xref:azure.communication.SmsClient>
40+
- <xref:azure.communication.sms.SmsClient>
41+
examples:
42+
- "Creating the SmsClient from a connection string.<!--[!code-python[Main](les\\\
43+
send_sms_to_single_recipient_sample.py )]-->\n\n<!-- literal_block {\"ids\": [],\
44+
\ \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
45+
: \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\
46+
\\py2docfx\\\\dist_temp\\\\30\\\\azure_communication_sms-1.1.0\\\\samples\\\\\
47+
send_sms_to_single_recipient_sample.py\", \"xml:space\": \"preserve\", \"force\"\
48+
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
49+
linenos\": false} -->\n\n````python\n\n sms_client = SmsClient.from_connection_string(self.connection_string)\n\
50+
\n ````\n"
4051
- uid: azure.communication.sms.SmsClient.send
4152
name: send
4253
summary: Sends SMSs to phone numbers.
43-
signature: 'send(from_: str, to: str | List[str], message: str, **kwargs: Any) ->
44-
[SmsSendResult]'
54+
signature: 'send(from_: str, to: str | List[str], message: str, *, enable_delivery_report:
55+
bool = False, tag: str | None = None, **kwargs: Any) -> [<class ''azure.communication.sms._models._models_py3.SmsSendResult''>]'
4556
parameters:
4657
- name: from
4758
description: The sender of the SMS.
@@ -54,7 +65,7 @@ methods:
5465
types:
5566
- <xref:typing.Union>[<xref:str>, <xref:typing.List>[<xref:str>]]
5667
- name: message
57-
description: The message in the SMS
68+
description: The message in the SMS.
5869
isRequired: true
5970
types:
6071
- <xref:str>

docs-ref-autogen/azure-communication-sms/azure.communication.sms.aio.SmsClient.yml

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,24 @@ fullName: azure.communication.sms.aio.SmsClient
55
module: azure.communication.sms.aio
66
inheritances:
77
- builtins.object
8-
summary: "A client to interact with the AzureCommunicationService Sms gateway asynchronously.\n\
9-
\n This client provides operations to send an SMS via a phone number."
8+
summary: 'A client to interact with the AzureCommunicationService Sms gateway asynchronously.
9+
10+
11+
This client provides operations to send an SMS via a phone number.'
1012
constructor:
11-
syntax: 'SmsClient(endpoint: str, credential: AsyncTokenCredential, **kwargs: Any)'
13+
syntax: 'SmsClient(endpoint: str, credential: AsyncTokenCredential | AzureKeyCredential,
14+
**kwargs: Any)'
1215
parameters:
1316
- name: endpoint
14-
description: "The endpoint url for Azure Communication Service resource.\n\nparam\
15-
\ AsyncTokenCredential credential:\n The AsyncTokenCredential we use to authenticate\
16-
\ against the service."
17+
description: The endpoint url for Azure Communication Service resource.
1718
isRequired: true
1819
types:
1920
- <xref:str>
2021
- name: credential
22+
description: The credential we use to authenticate against the service.
2123
isRequired: true
24+
types:
25+
- <xref:typing.Union>[<xref:AsyncTokenCredential>, <xref:AzureKeyCredential>]
2226
methods:
2327
- uid: azure.communication.sms.aio.SmsClient.close
2428
name: close
@@ -39,12 +43,22 @@ methods:
3943
return:
4044
description: Instance of SmsClient.
4145
types:
42-
- <xref:azure.communication.SmsClient>
46+
- <xref:azure.communication.sms.aio.SmsClient>
47+
examples:
48+
- "Creating the SmsClient from a connection string.<!--[!code-python[Main](les\\\
49+
send_sms_to_single_recipient_sample_async.py )]-->\n\n<!-- literal_block {\"ids\"\
50+
: [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\"\
51+
: \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\
52+
\\py2docfx\\\\dist_temp\\\\30\\\\azure_communication_sms-1.1.0\\\\samples\\\\\
53+
send_sms_to_single_recipient_sample_async.py\", \"xml:space\": \"preserve\", \"\
54+
force\": false, \"language\": \"python\", \"highlight_args\": {\"linenostart\"\
55+
: 1}, \"linenos\": false} -->\n\n````python\n\n sms_client = SmsClient.from_connection_string(self.connection_string)\n\
56+
\n ````\n"
4357
- uid: azure.communication.sms.aio.SmsClient.send
4458
name: send
4559
summary: Sends SMSs to phone numbers.
46-
signature: 'async send(from_: str, to: str | List[str], message: str, **kwargs:
47-
Any) -> [SmsSendResult]'
60+
signature: 'async send(from_: str, to: str | List[str], message: str, *, enable_delivery_report:
61+
bool = False, tag: str | None = None, **kwargs: Any) -> List[SmsSendResult]'
4862
parameters:
4963
- name: from
5064
description: The sender of the SMS.

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

Lines changed: 1 addition & 1 deletion
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 0x000001A9498008B0>
43+
defaultValue: <object object at 0x0000020EB08508B0>
4444
types:
4545
- <xref:datetime.datetime>
4646
- name: dataschema

docs-ref-autogen/azure-servicebus/azure.servicebus.aio.management.ServiceBusAdministrationClient.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ methods:
224224
keywordOnlyParameters:
225225
- name: filter
226226
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
227-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000024227E81590>
227+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000017F7CBCD7D0>
228228
types:
229229
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
230230
<xref:azure.servicebus.management.SqlRuleFilter>]

docs-ref-autogen/azure-servicebus/azure.servicebus.management.ServiceBusAdministrationClient.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ methods:
233233
keywordOnlyParameters:
234234
- name: filter
235235
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
236-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000024226FD1310>
236+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000017F7BD31AD0>
237237
types:
238238
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
239239
<xref:azure.servicebus.management.SqlRuleFilter>]

docs-ref-mapping/reference-preview.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
href: ~/docs-ref-services/preview/mgmt-advisor-readme.md
1313
children:
1414
- azure.mgmt.advisor
15-
- name: AgriFood
15+
- name: Agrifood
1616
href: ~/docs-ref-services/preview/agrifood.md
1717
landingPageType: Service
1818
items:

docs-ref-mapping/reference-previous.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
landingPageType: Root
33
expanded: false
44
items:
5-
- name: AgriFood
5+
- name: Agrifood
66
href: ~/docs-ref-services/legacy/agrifood.md
77
landingPageType: Service
88
items:

preview/docs-ref-autogen/azure-servicebus/azure.servicebus.aio.management.ServiceBusAdministrationClient.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ methods:
224224
keywordOnlyParameters:
225225
- name: filter
226226
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
227-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000020EE7C75590>
227+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x00000276B24CD2D0>
228228
types:
229229
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
230230
<xref:azure.servicebus.management.SqlRuleFilter>]

preview/docs-ref-autogen/azure-servicebus/azure.servicebus.management.ServiceBusAdministrationClient.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ methods:
233233
keywordOnlyParameters:
234234
- name: filter
235235
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
236-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000020EE5A1AC50>
236+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x00000276B0192D10>
237237
types:
238238
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
239239
<xref:azure.servicebus.management.SqlRuleFilter>]

previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -129,18 +129,18 @@ attributes:
129129
name: session
130130
- uid: azure.datalake.store.lib.DatalakeRESTInterface.ends
131131
name: ends
132-
signature: 'ends = {''APPEND'': (''post'', set(), {''append'', ''filesessionid'',
133-
''leaseid'', ''syncFlag'', ''offset''}), ''CHECKACCESS'': (''get'', set(), {''fsaction''}),
132+
signature: 'ends = {''APPEND'': (''post'', set(), {''leaseid'', ''offset'', ''append'',
133+
''syncFlag'', ''filesessionid''}), ''CHECKACCESS'': (''get'', set(), {''fsaction''}),
134134
''CONCAT'': (''post'', {''sources''}, {''sources''}), ''CREATE'': (''put'', set(),
135-
{''syncFlag'', ''filesessionid'', ''write'', ''leaseid'', ''overwrite''}), ''DELETE'':
135+
{''leaseid'', ''overwrite'', ''syncFlag'', ''write'', ''filesessionid''}), ''DELETE'':
136136
(''delete'', set(), {''recursive''}), ''GETCONTENTSUMMARY'': (''get'', set(),
137137
set()), ''GETFILESTATUS'': (''get'', set(), set()), ''LISTSTATUS'': (''get'',
138138
set(), {''listSize'', ''listAfter''}), ''MKDIRS'': (''put'', set(), set()), ''MODIFYACLENTRIES'':
139139
(''put'', {''aclSpec''}, {''aclSpec''}), ''MSCONCAT'': (''post'', set(), {''deleteSourceDirectory''}),
140-
''MSGETACLSTATUS'': (''get'', set(), set()), ''OPEN'': (''get'', set(), {''filesessionid'',
141-
''length'', ''read'', ''offset''}), ''REMOVEACL'': (''put'', set(), set()), ''REMOVEACLENTRIES'':
142-
(''put'', {''aclSpec''}, {''aclSpec''}), ''REMOVEDEFAULTACL'': (''put'', set(),
143-
set()), ''RENAME'': (''put'', {''destination''}, {''destination''}), ''SETACL'':
144-
(''put'', {''aclSpec''}, {''aclSpec''}), ''SETEXPIRY'': (''put'', {''expiryOption''},
145-
{''expiryOption'', ''expireTime''}), ''SETOWNER'': (''put'', set(), {''owner'',
146-
''group''}), ''SETPERMISSION'': (''put'', set(), {''permission''})}'
140+
''MSGETACLSTATUS'': (''get'', set(), set()), ''OPEN'': (''get'', set(), {''read'',
141+
''filesessionid'', ''offset'', ''length''}), ''REMOVEACL'': (''put'', set(), set()),
142+
''REMOVEACLENTRIES'': (''put'', {''aclSpec''}, {''aclSpec''}), ''REMOVEDEFAULTACL'':
143+
(''put'', set(), set()), ''RENAME'': (''put'', {''destination''}, {''destination''}),
144+
''SETACL'': (''put'', {''aclSpec''}, {''aclSpec''}), ''SETEXPIRY'': (''put'',
145+
{''expiryOption''}, {''expiryOption'', ''expireTime''}), ''SETOWNER'': (''put'',
146+
set(), {''owner'', ''group''}), ''SETPERMISSION'': (''put'', set(), {''permission''})}'

0 commit comments

Comments
 (0)