-
Notifications
You must be signed in to change notification settings - Fork 180
/
index.yml
220 lines (197 loc) · 7.63 KB
/
index.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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
### YamlMime:TSPackage
uid: '@azure/core-client'
name: '@azure/core-client'
summary: ''
type: package
classes:
- '@azure/core-client.ServiceClient'
interfaces:
- '@azure/core-client.AdditionalPolicyConfig'
- '@azure/core-client.BaseMapper'
- '@azure/core-client.CommonClientOptions'
- '@azure/core-client.CompositeMapper'
- '@azure/core-client.CompositeMapperType'
- '@azure/core-client.DeserializationContentTypes'
- '@azure/core-client.DeserializationPolicyOptions'
- '@azure/core-client.DictionaryMapper'
- '@azure/core-client.DictionaryMapperType'
- '@azure/core-client.EnumMapper'
- '@azure/core-client.EnumMapperType'
- '@azure/core-client.FullOperationResponse'
- '@azure/core-client.InternalClientPipelineOptions'
- '@azure/core-client.MapperConstraints'
- '@azure/core-client.OperationArguments'
- '@azure/core-client.OperationOptions'
- '@azure/core-client.OperationParameter'
- '@azure/core-client.OperationQueryParameter'
- '@azure/core-client.OperationRequestInfo'
- '@azure/core-client.OperationRequestOptions'
- '@azure/core-client.OperationResponseMap'
- '@azure/core-client.OperationSpec'
- '@azure/core-client.OperationURLParameter'
- '@azure/core-client.PolymorphicDiscriminator'
- '@azure/core-client.SequenceMapper'
- '@azure/core-client.SequenceMapperType'
- '@azure/core-client.SerializationPolicyOptions'
- '@azure/core-client.Serializer'
- '@azure/core-client.SerializerOptions'
- '@azure/core-client.ServiceClientOptions'
- '@azure/core-client.SimpleMapperType'
- '@azure/core-client.SpanConfig'
- '@azure/core-client.XmlOptions'
typeAliases:
- '@azure/core-client.Mapper'
- '@azure/core-client.MapperType'
- '@azure/core-client.OperationRequest'
- '@azure/core-client.ParameterPath'
- '@azure/core-client.QueryCollectionFormat'
- '@azure/core-client.RawResponseCallback'
functions:
- name: authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
uid: '@azure/core-client.authorizeRequestOnClaimChallenge'
package: '@azure/core-client'
summary: >-
This function can be used as a callback for the
`bearerTokenAuthenticationPolicy` of `@azure/core-rest-pipeline`, to
support CAE challenges:
[Continuous Access
Evaluation](https://docs.microsoft.com/azure/active-directory/conditional-access/concept-continuous-access-evaluation).
Call the `bearerTokenAuthenticationPolicy` with the following options:
```ts
import { bearerTokenAuthenticationPolicy } from
"@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
```
Once provided, the `bearerTokenAuthenticationPolicy` policy will
internally handle Continuous Access Evaluation (CAE) challenges.
When it can't complete a challenge it will return the 401 (unauthorized)
response from ARM.
Example challenge with claims:
```
Bearer authorization_uri="https://login.windows-ppe.net/",
error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function authorizeRequestOnClaimChallenge(onChallengeOptions:
AuthorizeRequestOnChallengeOptions): Promise<boolean>
parameters:
- id: onChallengeOptions
type: >-
<xref
uid="@azure/core-rest-pipeline.AuthorizeRequestOnChallengeOptions"
/>
description: ''
return:
description: ''
type: Promise<boolean>
- name: authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
uid: '@azure/core-client.authorizeRequestOnTenantChallenge'
package: '@azure/core-client'
summary: >-
Defines a callback to handle auth challenge for Storage APIs.
This implements the bearer challenge process described here:
https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge
Handling has specific features for storage that departs to the general AAD
challenge docs.
remarks: ''
isDeprecated: false
syntax:
content: >-
function authorizeRequestOnTenantChallenge(challengeOptions:
AuthorizeRequestOnChallengeOptions): Promise<boolean>
parameters:
- id: challengeOptions
type: >-
<xref
uid="@azure/core-rest-pipeline.AuthorizeRequestOnChallengeOptions"
/>
description: ''
return:
description: ''
type: Promise<boolean>
- name: createClientPipeline(InternalClientPipelineOptions)
uid: '@azure/core-client.createClientPipeline'
package: '@azure/core-client'
summary: |-
Creates a new Pipeline for use with a Service Client.
Adds in deserializationPolicy by default.
Also adds in bearerTokenAuthenticationPolicy if passed a TokenCredential.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createClientPipeline(options?: InternalClientPipelineOptions):
Pipeline
parameters:
- id: options
type: <xref uid="@azure/core-client.InternalClientPipelineOptions" />
description: Options to customize the created pipeline.
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.Pipeline" />
- name: 'createSerializer({[key: string]: any}, boolean)'
uid: '@azure/core-client.createSerializer'
package: '@azure/core-client'
summary: Method that creates and returns a Serializer.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createSerializer(modelMappers?: {[key: string]: any}, isXML?:
boolean): Serializer
parameters:
- id: modelMappers
type: '{[key: string]: any}'
description: Known models to map
- id: isXML
type: boolean
description: If XML should be supported
return:
description: ''
type: <xref uid="@azure/core-client.Serializer" />
- name: deserializationPolicy(DeserializationPolicyOptions)
uid: '@azure/core-client.deserializationPolicy'
package: '@azure/core-client'
summary: >-
This policy handles parsing out responses according to OperationSpecs on
the request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deserializationPolicy(options?: DeserializationPolicyOptions):
PipelinePolicy
parameters:
- id: options
type: <xref uid="@azure/core-client.DeserializationPolicyOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.PipelinePolicy" />
- name: serializationPolicy(SerializationPolicyOptions)
uid: '@azure/core-client.serializationPolicy'
package: '@azure/core-client'
summary: |-
This policy handles assembling the request body and headers using
an OperationSpec and OperationArguments on the request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function serializationPolicy(options?: SerializationPolicyOptions):
PipelinePolicy
parameters:
- id: options
type: <xref uid="@azure/core-client.SerializationPolicyOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.PipelinePolicy" />