/
AppendBlobCreateOptions.yml
174 lines (166 loc) · 5.35 KB
/
AppendBlobCreateOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
### YamlMime:TSType
name: AppendBlobCreateOptions
uid: '@azure/storage-blob.AppendBlobCreateOptions'
package: '@azure/storage-blob'
summary: 'Options to configure <xref:AppendBlobClient.create> operation.'
fullName: AppendBlobCreateOptions
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: abortSignal
uid: '@azure/storage-blob.AppendBlobCreateOptions.abortSignal'
package: '@azure/storage-blob'
summary: >-
An implementation of the `AbortSignalLike` interface to signal the request
to cancel the operation.
For example, use the @azure/abort-controller to create an
`AbortSignal`.
fullName: abortSignal
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
type: AbortSignalLike
description: ''
- name: blobHTTPHeaders
uid: '@azure/storage-blob.AppendBlobCreateOptions.blobHTTPHeaders'
package: '@azure/storage-blob'
summary: |-
HTTP headers to set when creating append blobs. A common header
to set is `blobContentType`, enabling the browser to provide functionality
based on file type.
fullName: blobHTTPHeaders
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'blobHTTPHeaders?: BlobHTTPHeaders'
return:
type: <xref uid="@azure/storage-blob.BlobHTTPHeaders" />
description: ''
- name: conditions
uid: '@azure/storage-blob.AppendBlobCreateOptions.conditions'
package: '@azure/storage-blob'
summary: Conditions to meet when creating append blobs.
fullName: conditions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'conditions?: BlobRequestConditions'
return:
type: <xref uid="@azure/storage-blob.BlobRequestConditions" />
description: ''
- name: customerProvidedKey
uid: '@azure/storage-blob.AppendBlobCreateOptions.customerProvidedKey'
package: '@azure/storage-blob'
summary: Customer Provided Key Info.
fullName: customerProvidedKey
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'customerProvidedKey?: CpkInfo'
return:
type: <xref uid="@azure/storage-blob.CpkInfo" />
description: ''
- name: encryptionScope
uid: '@azure/storage-blob.AppendBlobCreateOptions.encryptionScope'
package: '@azure/storage-blob'
summary: >-
Optional. Version 2019-07-07 and later. Specifies the name of the
encryption scope to use to
encrypt the data provided in the request. If not specified, encryption is
performed with the
default account encryption scope. For more information, see Encryption at
Rest for Azure
Storage Services.
fullName: encryptionScope
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'encryptionScope?: string'
return:
type: string
description: ''
- name: immutabilityPolicy
uid: '@azure/storage-blob.AppendBlobCreateOptions.immutabilityPolicy'
package: '@azure/storage-blob'
summary: >-
Optional. Specifies immutability policy for a blob.
Note that is parameter is only applicable to a blob within a container
that
has version level worm enabled.
fullName: immutabilityPolicy
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'immutabilityPolicy?: BlobImmutabilityPolicy'
return:
type: <xref uid="@azure/storage-blob.BlobImmutabilityPolicy" />
description: ''
- name: legalHold
uid: '@azure/storage-blob.AppendBlobCreateOptions.legalHold'
package: '@azure/storage-blob'
summary: >-
Optional. Indicates if a legal hold should be placed on the blob.
Note that is parameter is only applicable to a blob within a container
that
has version level worm enabled.
fullName: legalHold
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'legalHold?: boolean'
return:
type: boolean
description: ''
- name: metadata
uid: '@azure/storage-blob.AppendBlobCreateOptions.metadata'
package: '@azure/storage-blob'
summary: >-
A collection of key-value string pair to associate with the blob when
creating append blobs.
fullName: metadata
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'metadata?: Metadata'
return:
type: <xref uid="@azure/storage-blob.Metadata" />
description: ''
- name: tags
uid: '@azure/storage-blob.AppendBlobCreateOptions.tags'
package: '@azure/storage-blob'
summary: Blob tags.
fullName: tags
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'tags?: Tags'
return:
type: <xref uid="@azure/storage-blob.Tags" />
description: ''
- name: tracingOptions
uid: '@azure/storage-blob.AppendBlobCreateOptions.tracingOptions'
package: '@azure/storage-blob'
summary: Options to configure spans created when tracing is enabled.
fullName: tracingOptions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
type: OperationTracingOptions
description: ''
extends: <xref uid="@azure/storage-blob.CommonOptions" />