-
Notifications
You must be signed in to change notification settings - Fork 180
/
CommonGenerateSasUrlOptions.yml
158 lines (155 loc) · 4.9 KB
/
CommonGenerateSasUrlOptions.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
### YamlMime:TSType
name: CommonGenerateSasUrlOptions
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions'
package: '@azure/storage-file-share'
summary: >-
Common options of the
[ShareGenerateSasUrlOptions](xref:@azure/storage-file-share.ShareGenerateSasUrlOptions)
and
[FileGenerateSasUrlOptions](xref:@azure/storage-file-share.FileGenerateSasUrlOptions).
fullName: CommonGenerateSasUrlOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: cacheControl
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.cacheControl'
package: '@azure/storage-file-share'
summary: Optional. The cache-control header for the SAS.
fullName: cacheControl
remarks: ''
isDeprecated: false
syntax:
content: 'cacheControl?: string'
return:
description: ''
type: string
- name: contentDisposition
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.contentDisposition'
package: '@azure/storage-file-share'
summary: Optional. The content-disposition header for the SAS.
fullName: contentDisposition
remarks: ''
isDeprecated: false
syntax:
content: 'contentDisposition?: string'
return:
description: ''
type: string
- name: contentEncoding
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.contentEncoding'
package: '@azure/storage-file-share'
summary: Optional. The content-encoding header for the SAS.
fullName: contentEncoding
remarks: ''
isDeprecated: false
syntax:
content: 'contentEncoding?: string'
return:
description: ''
type: string
- name: contentLanguage
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.contentLanguage'
package: '@azure/storage-file-share'
summary: Optional. The content-language header for the SAS.
fullName: contentLanguage
remarks: ''
isDeprecated: false
syntax:
content: 'contentLanguage?: string'
return:
description: ''
type: string
- name: contentType
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.contentType'
package: '@azure/storage-file-share'
summary: Optional. The content-type header for the SAS.
fullName: contentType
remarks: ''
isDeprecated: false
syntax:
content: 'contentType?: string'
return:
description: ''
type: string
- name: expiresOn
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.expiresOn'
package: '@azure/storage-file-share'
summary: >-
Optional only when identifier is provided. The time after which the SAS
will no longer work.
fullName: expiresOn
remarks: ''
isDeprecated: false
syntax:
content: 'expiresOn?: Date'
return:
description: ''
type: Date
- name: identifier
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.identifier'
package: '@azure/storage-file-share'
summary: >-
Optional. The name of the access policy on the share this SAS references
if any.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
fullName: identifier
remarks: ''
isDeprecated: false
syntax:
content: 'identifier?: string'
return:
description: ''
type: string
- name: ipRange
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.ipRange'
package: '@azure/storage-file-share'
summary: Optional. IP ranges allowed in this SAS.
fullName: ipRange
remarks: ''
isDeprecated: false
syntax:
content: 'ipRange?: SasIPRange'
return:
description: ''
type: <xref uid="@azure/storage-file-share.SasIPRange" />
- name: protocol
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.protocol'
package: '@azure/storage-file-share'
summary: Optional. SAS protocols, HTTPS only or HTTPSandHTTP
fullName: protocol
remarks: ''
isDeprecated: false
syntax:
content: 'protocol?: SASProtocol'
return:
description: ''
type: <xref uid="@azure/storage-file-share.SASProtocol" />
- name: startsOn
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.startsOn'
package: '@azure/storage-file-share'
summary: Optional. When the SAS will take effect.
fullName: startsOn
remarks: ''
isDeprecated: false
syntax:
content: 'startsOn?: Date'
return:
description: ''
type: Date
- name: version
uid: '@azure/storage-file-share.CommonGenerateSasUrlOptions.version'
package: '@azure/storage-file-share'
summary: >-
The version of the service this SAS will target. If not specified, it will
default to the version targeted by the
library.
fullName: version
remarks: ''
isDeprecated: false
syntax:
content: 'version?: string'
return:
description: ''
type: string