-
Notifications
You must be signed in to change notification settings - Fork 187
/
IAccountSASSignatureValues.yml
144 lines (136 loc) · 4.16 KB
/
IAccountSASSignatureValues.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
### YamlMime:TSType
name: IAccountSASSignatureValues
uid: '@azure/storage-file.IAccountSASSignatureValues'
package: '@azure/storage-file'
summary: >
ONLY AVAILABLE IN NODE.JS RUNTIME.
IAccountSASSignatureValues is used to generate a Shared Access Signature (SAS)
for an Azure Storage account. Once
all the values here are set appropriately, call generateSASQueryParameters()
to obtain a representation of the SAS
which can actually be applied to file urls. Note: that both this class and
<xref:SASQueryParameters> exist because
the former is mutable and a logical representation while the latter is
immutable and used to generate actual REST
requests.
fullName: IAccountSASSignatureValues
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: expiryTime
uid: '@azure/storage-file.IAccountSASSignatureValues.expiryTime'
package: '@azure/storage-file'
summary: The time after which the SAS will no longer work.
fullName: expiryTime
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'expiryTime: Date'
return:
type: Date
description: ''
- name: ipRange
uid: '@azure/storage-file.IAccountSASSignatureValues.ipRange'
package: '@azure/storage-file'
summary: Optional. IP range allowed.
fullName: ipRange
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'ipRange?: IIPRange'
return:
type: <xref uid="@azure/storage-file.IIPRange" />
description: ''
- name: permissions
uid: '@azure/storage-file.IAccountSASSignatureValues.permissions'
package: '@azure/storage-file'
summary: >-
Specifies which operations the SAS user may perform. Please refer to
<xref:AccountSASPermissions> for help
constructing the permissions string.
fullName: permissions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'permissions: string'
return:
type: string
description: ''
- name: protocol
uid: '@azure/storage-file.IAccountSASSignatureValues.protocol'
package: '@azure/storage-file'
summary: Optional. SAS protocols allowed.
fullName: protocol
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protocol?: SASProtocol'
return:
type: <xref uid="@azure/storage-file.SASProtocol" />
description: ''
- name: resourceTypes
uid: '@azure/storage-file.IAccountSASSignatureValues.resourceTypes'
package: '@azure/storage-file'
summary: >-
The values that indicate the resource types accessible with this SAS.
Please refer
to <xref:AccountSASResourceTypes> to construct this value.
fullName: resourceTypes
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'resourceTypes: string'
return:
type: string
description: ''
- name: services
uid: '@azure/storage-file.IAccountSASSignatureValues.services'
package: '@azure/storage-file'
summary: >-
The values that indicate the services accessible with this SAS. Please
refer to <xref:AccountSASServices> to
construct this value.
fullName: services
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'services: string'
return:
type: string
description: ''
- name: startTime
uid: '@azure/storage-file.IAccountSASSignatureValues.startTime'
package: '@azure/storage-file'
summary: Optional. When the SAS will take effect.
fullName: startTime
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'startTime?: Date'
return:
type: Date
description: ''
- name: version
uid: '@azure/storage-file.IAccountSASSignatureValues.version'
package: '@azure/storage-file'
summary: >-
If not provided, this defaults to the service version targeted by this
version of the library.
fullName: version
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'version?: undefined | string'
return:
type: undefined | string
description: ''