Skip to content

Commit 44b024c

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=515413&view=results
1 parent f7770dd commit 44b024c

File tree

47 files changed

+1233
-1440
lines changed

Some content is hidden

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

47 files changed

+1233
-1440
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ constructor:
3838
- <xref:object>
3939
- name: time
4040
description: Optional. The time (in UTC) the event was generated.
41-
defaultValue: <object object at 0x00000194EAF2EDE0>
41+
defaultValue: <object object at 0x0000029D3119EDE0>
4242
types:
4343
- <xref:datetime.datetime>
4444
- name: dataschema

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ methods:
222222
keywordOnlyParameters:
223223
- name: filter
224224
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
225-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000023F807C0350>
225+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000017B748F1450>
226226
types:
227227
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
228228
<xref:azure.servicebus.management.SqlRuleFilter>]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ methods:
231231
keywordOnlyParameters:
232232
- name: filter
233233
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
234-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000023FFE8DD350>
234+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x0000017B72C79510>
235235
types:
236236
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
237237
<xref:azure.servicebus.management.SqlRuleFilter>]

docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.AccessControlChangeCounters.yml

+15-14
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,15 @@ module: azure.storage.filedatalake
66
summary: AccessControlChangeCounters contains counts of operations that change Access
77
Control Lists recursively.
88
constructor:
9-
syntax: AccessControlChangeCounters(directories_successful, files_successful, failure_count)
9+
syntax: 'AccessControlChangeCounters(directories_successful: int, files_successful:
10+
int, failure_count: int)'
1011
parameters:
1112
- name: directories_successful
1213
isRequired: true
1314
- name: files_successful
1415
isRequired: true
1516
- name: failure_count
1617
isRequired: true
17-
variables:
18-
- description: Number of directories where Access Control List has been updated successfully.
19-
name: directories_successful
20-
types:
21-
- <xref:int>
22-
- description: Number of files where Access Control List has been updated successfully.
23-
name: files_successful
24-
types:
25-
- <xref:int>
26-
- description: Number of paths where Access Control List update has failed.
27-
name: failure_count
28-
types:
29-
- <xref:int>
3018
methods:
3119
- uid: azure.storage.filedatalake.AccessControlChangeCounters.get
3220
name: get
@@ -54,3 +42,16 @@ methods:
5442
- uid: azure.storage.filedatalake.AccessControlChangeCounters.values
5543
name: values
5644
signature: values()
45+
attributes:
46+
- uid: azure.storage.filedatalake.AccessControlChangeCounters.directories_successful
47+
name: directories_successful
48+
summary: Number of directories where Access Control List has been updated successfully.
49+
signature: 'directories_successful: int'
50+
- uid: azure.storage.filedatalake.AccessControlChangeCounters.failure_count
51+
name: failure_count
52+
summary: Number of paths where Access Control List update has failed.
53+
signature: 'failure_count: int'
54+
- uid: azure.storage.filedatalake.AccessControlChangeCounters.files_successful
55+
name: files_successful
56+
summary: Number of files where Access Control List has been updated successfully.
57+
signature: 'files_successful: int'

docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.AccessControlChangeFailure.yml

+15-14
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,15 @@ fullName: azure.storage.filedatalake.AccessControlChangeFailure
55
module: azure.storage.filedatalake
66
summary: Represents an entry that failed to update Access Control List.
77
constructor:
8-
syntax: AccessControlChangeFailure(name, is_directory, error_message)
8+
syntax: 'AccessControlChangeFailure(name: str, is_directory: bool, error_message:
9+
str)'
910
parameters:
1011
- name: name
1112
isRequired: true
1213
- name: is_directory
1314
isRequired: true
1415
- name: error_message
1516
isRequired: true
16-
variables:
17-
- description: Name of the entry.
18-
name: name
19-
types:
20-
- <xref:str>
21-
- description: Indicates whether the entry is a directory.
22-
name: is_directory
23-
types:
24-
- <xref:bool>
25-
- description: Indicates the reason why the entry failed to update.
26-
name: error_message
27-
types:
28-
- <xref:str>
2917
methods:
3018
- uid: azure.storage.filedatalake.AccessControlChangeFailure.get
3119
name: get
@@ -53,3 +41,16 @@ methods:
5341
- uid: azure.storage.filedatalake.AccessControlChangeFailure.values
5442
name: values
5543
signature: values()
44+
attributes:
45+
- uid: azure.storage.filedatalake.AccessControlChangeFailure.error_message
46+
name: error_message
47+
summary: Indicates the reason why the entry failed to update.
48+
signature: 'error_message: str'
49+
- uid: azure.storage.filedatalake.AccessControlChangeFailure.is_directory
50+
name: is_directory
51+
summary: Indicates whether the entry is a directory.
52+
signature: 'is_directory: bool'
53+
- uid: azure.storage.filedatalake.AccessControlChangeFailure.name
54+
name: name
55+
summary: Name of the entry.
56+
signature: 'name: str'

docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.AccessControlChangeResult.yml

+13-13
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,13 @@ module: azure.storage.filedatalake
66
summary: AccessControlChangeResult contains result of operations that change Access
77
Control Lists recursively.
88
constructor:
9-
syntax: AccessControlChangeResult(counters, continuation)
9+
syntax: 'AccessControlChangeResult(counters: AccessControlChangeCounters | None,
10+
continuation: str | None)'
1011
parameters:
1112
- name: counters
1213
isRequired: true
1314
- name: continuation
1415
isRequired: true
15-
variables:
16-
- description: Contains counts of paths changed from start of the operation.
17-
name: counters
18-
types:
19-
- <xref:azure.storage.filedatalake.AccessControlChangeCounters>
20-
- description: 'Optional continuation token.
21-
22-
Value is present when operation is split into multiple batches and can be used
23-
to resume progress.'
24-
name: continuation
25-
types:
26-
- <xref:str>
2716
methods:
2817
- uid: azure.storage.filedatalake.AccessControlChangeResult.get
2918
name: get
@@ -51,3 +40,14 @@ methods:
5140
- uid: azure.storage.filedatalake.AccessControlChangeResult.values
5241
name: values
5342
signature: values()
43+
attributes:
44+
- uid: azure.storage.filedatalake.AccessControlChangeResult.continuation
45+
name: continuation
46+
summary: 'Continuation token. Value is present when operation is split into
47+
48+
multiple batches and can be used to resume progress.'
49+
signature: 'continuation: str | None'
50+
- uid: azure.storage.filedatalake.AccessControlChangeResult.counters
51+
name: counters
52+
summary: Contains counts of paths changed from start of the operation.
53+
signature: 'counters: AccessControlChangeCounters | None = None'

docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.AccessControlChanges.yml

+22-21
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ summary: 'AccessControlChanges contains batch and cumulative counts of operation
1010
Additionally it exposes path entries that failed to update while these operations
1111
progress.'
1212
constructor:
13-
syntax: AccessControlChanges(batch_counters, aggregate_counters, batch_failures,
14-
continuation)
13+
syntax: 'AccessControlChanges(batch_counters: AccessControlChangeCounters, aggregate_counters:
14+
AccessControlChangeCounters, batch_failures: List[AccessControlChangeFailure],
15+
continuation: str | None)'
1516
parameters:
1617
- name: batch_counters
1718
isRequired: true
@@ -21,25 +22,6 @@ constructor:
2122
isRequired: true
2223
- name: continuation
2324
isRequired: true
24-
variables:
25-
- description: Contains counts of paths changed within single batch.
26-
name: batch_counters
27-
types:
28-
- <xref:azure.storage.filedatalake.AccessControlChangeCounters>
29-
- description: Contains counts of paths changed from start of the operation.
30-
name: aggregate_counters
31-
types:
32-
- <xref:azure.storage.filedatalake.AccessControlChangeCounters>
33-
- description: List of path entries that failed to update Access Control List within
34-
single batch.
35-
name: batch_failures
36-
types:
37-
- <xref:list>(<xref:azure.storage.filedatalake.AccessControlChangeFailure>)
38-
- description: An opaque continuation token that may be used to resume the operations
39-
in case of failures.
40-
name: continuation
41-
types:
42-
- <xref:str>
4325
methods:
4426
- uid: azure.storage.filedatalake.AccessControlChanges.get
4527
name: get
@@ -67,3 +49,22 @@ methods:
6749
- uid: azure.storage.filedatalake.AccessControlChanges.values
6850
name: values
6951
signature: values()
52+
attributes:
53+
- uid: azure.storage.filedatalake.AccessControlChanges.aggregate_counters
54+
name: aggregate_counters
55+
summary: Contains counts of paths changed from start of the operation.
56+
signature: 'aggregate_counters: AccessControlChangeCounters'
57+
- uid: azure.storage.filedatalake.AccessControlChanges.batch_counters
58+
name: batch_counters
59+
summary: Contains counts of paths changed within single batch.
60+
signature: 'batch_counters: AccessControlChangeCounters'
61+
- uid: azure.storage.filedatalake.AccessControlChanges.batch_failures
62+
name: batch_failures
63+
summary: List of path entries that failed to update Access Control List within single
64+
batch.
65+
signature: 'batch_failures: List[AccessControlChangeFailure]'
66+
- uid: azure.storage.filedatalake.AccessControlChanges.continuation
67+
name: continuation
68+
summary: An opaque continuation token that may be used to resume the operations
69+
in case of failures.
70+
signature: 'continuation: str | None'

docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.AccessPolicy.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ summary: 'Access Policy class used by the set and get access policy methods in e
3838
3939
request will fail with status code 400 (Bad Request).'
4040
constructor:
41-
syntax: AccessPolicy(permission=None, expiry=None, **kwargs)
41+
syntax: 'AccessPolicy(permission: FileSystemSasPermissions | str | None = None,
42+
expiry: datetime | str | None = None, **kwargs: Any)'
4243
parameters:
4344
- name: permission
4445
description: 'The permissions associated with the shared access signature. The
@@ -52,8 +53,8 @@ constructor:
5253
specified in an associated stored access policy.'
5354
defaultValue: None
5455
types:
55-
- <xref:str>
5656
- <xref:azure.storage.datalake.FileSystemSasPermissions>
57+
- <xref:str>
5758
- name: expiry
5859
description: 'The time at which the shared access signature becomes invalid.
5960

docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.AccountSasPermissions.yml

+35-2
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,53 @@ uid: azure.storage.filedatalake.AccountSasPermissions
33
name: AccountSasPermissions
44
fullName: azure.storage.filedatalake.AccountSasPermissions
55
module: azure.storage.filedatalake
6+
summary: '<xref:azure.storage.filedatalake.ResourceTypes> class to be used with generate_account_sas
7+
8+
function and for the AccessPolicies used with set_*_acl. There are two types of
9+
10+
SAS which may be used to grant resource access. One is to grant access to a
11+
12+
specific resource (resource-specific). Another is to grant access to the
13+
14+
entire service for a specific account and allow certain operations based on
15+
16+
perms found here.'
617
constructor:
7-
syntax: AccountSasPermissions(read=False, write=False, delete=False, list=False,
8-
create=False)
18+
syntax: 'AccountSasPermissions(read: bool = False, write: bool = False, delete:
19+
bool = False, list: bool = False, create: bool = False)'
920
parameters:
1021
- name: read
22+
description: 'Valid for all signed resources types (Service, Container, and Object).
23+
24+
Permits read permissions to the specified resource type.'
1125
defaultValue: 'False'
26+
types:
27+
- <xref:bool>
1228
- name: write
29+
description: 'Valid for all signed resources types (Service, Container, and Object).
30+
31+
Permits write permissions to the specified resource type.'
1332
defaultValue: 'False'
33+
types:
34+
- <xref:bool>
1435
- name: delete
36+
description: Valid for Container and Object resource types, except for queue messages.
1537
defaultValue: 'False'
38+
types:
39+
- <xref:bool>
1640
- name: list
41+
description: Valid for Service and Container resource types only.
1742
defaultValue: 'False'
43+
types:
44+
- <xref:bool>
1845
- name: create
46+
description: 'Valid for the following Object resource types only: blobs and files.
47+
48+
Users can create new blobs or files, but may not overwrite existing blobs or
49+
files.'
1950
defaultValue: 'False'
51+
types:
52+
- <xref:bool>
2053
methods:
2154
- uid: azure.storage.filedatalake.AccountSasPermissions.from_string
2255
name: from_string

docs-ref-autogen/azure-storage-file-datalake/azure.storage.filedatalake.AnalyticsLogging.yml

+29-29
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,7 @@ fullName: azure.storage.filedatalake.AnalyticsLogging
55
module: azure.storage.filedatalake
66
summary: Azure Analytics Logging settings.
77
constructor:
8-
syntax: AnalyticsLogging(**kwargs)
9-
keywordOnlyParameters:
10-
- name: version
11-
description: The version of Storage Analytics to configure. The default value
12-
is 1.0.
13-
types:
14-
- <xref:str>
15-
- name: delete
16-
description: Indicates whether all delete requests should be logged. The default
17-
value is *False*.
18-
types:
19-
- <xref:bool>
20-
- name: read
21-
description: Indicates whether all read requests should be logged. The default
22-
value is *False*.
23-
types:
24-
- <xref:bool>
25-
- name: write
26-
description: Indicates whether all write requests should be logged. The default
27-
value is *False*.
28-
types:
29-
- <xref:bool>
30-
- name: retention_policy
31-
description: 'Determines how long the associated data should persist. If not specified
32-
the retention
33-
34-
policy will be disabled by default.'
35-
types:
36-
- <xref:azure.storage.filedatalake.RetentionPolicy>
8+
syntax: 'AnalyticsLogging(**kwargs: Any)'
379
methods:
3810
- uid: azure.storage.filedatalake.AnalyticsLogging.as_dict
3911
name: as_dict
@@ -146,3 +118,31 @@ methods:
146118
description: A dict JSON compatible object
147119
types:
148120
- <xref:dict>
121+
attributes:
122+
- uid: azure.storage.filedatalake.AnalyticsLogging.delete
123+
name: delete
124+
summary: Indicates whether all delete requests should be logged. The default value
125+
is *False*.
126+
signature: 'delete: bool'
127+
- uid: azure.storage.filedatalake.AnalyticsLogging.read
128+
name: read
129+
summary: Indicates whether all read requests should be logged. The default value
130+
is *False*.
131+
signature: 'read: bool'
132+
- uid: azure.storage.filedatalake.AnalyticsLogging.retention_policy
133+
name: retention_policy
134+
summary: 'Determines how long the associated data should persist. If not specified
135+
the retention
136+
137+
policy will be disabled by default.'
138+
signature: 'retention_policy: RetentionPolicy = <azure.storage.filedatalake._models.RetentionPolicy
139+
object>'
140+
- uid: azure.storage.filedatalake.AnalyticsLogging.version
141+
name: version
142+
summary: The version of Storage Analytics to configure. The default value is 1.0.
143+
signature: 'version: str'
144+
- uid: azure.storage.filedatalake.AnalyticsLogging.write
145+
name: write
146+
summary: Indicates whether all write requests should be logged. The default value
147+
is *False*.
148+
signature: 'write: bool'

0 commit comments

Comments
 (0)