Skip to content

Commit cc6a024

Browse files
author
VSC-Service-Account
committed
CI Update
1 parent 613ffd7 commit cc6a024

File tree

617 files changed

+93032
-0
lines changed

Some content is hidden

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

617 files changed

+93032
-0
lines changed

‎preview/docs-ref-autogen/azure-core/azure.core.Configuration(class).yml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
### YamlMime:UniversalReference
2+
api_name: []
3+
items:
4+
- children: []
5+
class: azure.core.Configuration
6+
fullName: azure.core.Configuration
7+
inheritance:
8+
- type: builtins.object
9+
langs:
10+
- python
11+
module: azure.core
12+
name: Configuration
13+
summary: 'Provides the home for all of the configurable policies in the pipeline.
14+
15+
16+
A new Configuration object provides no default policies and does not specify in
17+
what
18+
19+
order the policies will be added to the pipeline. The SDK developer must specify
20+
each
21+
22+
of the policy defaults as required by the service and use the policies in the
23+
24+
Configuration to construct the pipeline correctly, as well as inserting any
25+
26+
unexposed/non-configurable policies.'
27+
syntax:
28+
content: Configuration(transport=None, **kwargs)
29+
parameters:
30+
- description: Provides the configuration parameters for the transport.
31+
id: connection
32+
type:
33+
- azure.core.ConnectionConfiguration
34+
- description: Provides parameters for custom or additional headers to be sent
35+
with the request.
36+
id: headers_policy
37+
- description: Provides configuration parameters for proxy.
38+
id: proxy_policy
39+
- description: Provides configuration parameters for redirects.
40+
id: redirect_policy
41+
- description: Provides configuration parameters for retries in the pipeline.
42+
id: retry_policy
43+
- description: Provides configuration parameters for a custom hook.
44+
id: custom_hook_policy
45+
- description: Provides configuration parameters for logging.
46+
id: logging_policy
47+
- description: 'Provides configuration parameters to append custom values to the
48+
49+
User-Agent header.'
50+
id: user_agent_policy
51+
- description: 'Provides configuration parameters for adding a bearer token Authorization
52+
53+
header to requests.'
54+
id: authentication_policy
55+
- description: 'The Http Transport type. E.g. RequestsTransport, AsyncioRequestsTransport,
56+
57+
TrioRequestsTransport, AioHttpTransport.'
58+
id: transport
59+
type: class
60+
uid: azure.core.Configuration
61+
references: []

‎preview/docs-ref-autogen/azure-core/azure.core.HttpRequest.yml

+214
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
### YamlMime:UniversalReference
2+
api_name: []
3+
items:
4+
- children:
5+
- azure.core.HttpRequest.body
6+
- azure.core.HttpRequest.format_parameters
7+
- azure.core.HttpRequest.query
8+
- azure.core.HttpRequest.set_bytes_body
9+
- azure.core.HttpRequest.set_formdata_body
10+
- azure.core.HttpRequest.set_json_body
11+
- azure.core.HttpRequest.set_streamed_data_body
12+
- azure.core.HttpRequest.set_xml_body
13+
class: azure.core.HttpRequest
14+
fullName: azure.core.HttpRequest
15+
inheritance:
16+
- type: builtins.object
17+
langs:
18+
- python
19+
module: azure.core
20+
name: HttpRequest
21+
summary: 'Represents a HTTP request.
22+
23+
24+
URL can be given without query parameters, to be added later using "format_parameters".'
25+
syntax:
26+
content: HttpRequest(method, url, headers=None, files=None, data=None)
27+
parameters:
28+
- description: HTTP method (GET, HEAD, etc.)
29+
id: method
30+
type:
31+
- str
32+
- description: At least complete scheme/host/path
33+
id: url
34+
type:
35+
- str
36+
- description: HTTP headers
37+
id: headers
38+
type:
39+
- dict[str,str]
40+
- description: Files list.
41+
id: files
42+
- description: Body to be sent.
43+
id: data
44+
type:
45+
- bytes
46+
- str.
47+
type: class
48+
uid: azure.core.HttpRequest
49+
- class: azure.core.HttpRequest
50+
fullName: azure.core.HttpRequest.body
51+
langs:
52+
- python
53+
module: azure.core
54+
name: body
55+
summary: Alias to data.
56+
syntax: {}
57+
type: attribute
58+
uid: azure.core.HttpRequest.body
59+
- class: azure.core.HttpRequest
60+
fullName: azure.core.HttpRequest.format_parameters
61+
langs:
62+
- python
63+
module: azure.core
64+
name: format_parameters(params)
65+
summary: 'Format parameters into a valid query string.
66+
67+
It''s assumed all parameters have already been quoted as
68+
69+
valid URL strings.'
70+
syntax:
71+
content: format_parameters(params)
72+
parameters:
73+
- description: A dictionary of parameters.
74+
id: params
75+
type:
76+
- dict
77+
type: method
78+
uid: azure.core.HttpRequest.format_parameters
79+
- class: azure.core.HttpRequest
80+
fullName: azure.core.HttpRequest.query
81+
langs:
82+
- python
83+
module: azure.core
84+
name: query
85+
summary: The query parameters of the request as a dict.
86+
syntax: {}
87+
type: attribute
88+
uid: azure.core.HttpRequest.query
89+
- class: azure.core.HttpRequest
90+
fullName: azure.core.HttpRequest.set_bytes_body
91+
langs:
92+
- python
93+
module: azure.core
94+
name: set_bytes_body(data)
95+
summary: Set generic bytes as the body of the request.
96+
syntax:
97+
content: set_bytes_body(data)
98+
parameters:
99+
- description: The request field data.
100+
id: data
101+
type: method
102+
uid: azure.core.HttpRequest.set_bytes_body
103+
- class: azure.core.HttpRequest
104+
fullName: azure.core.HttpRequest.set_formdata_body
105+
langs:
106+
- python
107+
module: azure.core
108+
name: set_formdata_body(data=None)
109+
summary: Set form-encoded data as the body of the request.
110+
syntax:
111+
content: set_formdata_body(data=None)
112+
parameters:
113+
- defaultValue: None
114+
description: The request field data.
115+
id: data
116+
type: method
117+
uid: azure.core.HttpRequest.set_formdata_body
118+
- class: azure.core.HttpRequest
119+
fullName: azure.core.HttpRequest.set_json_body
120+
langs:
121+
- python
122+
module: azure.core
123+
name: set_json_body(data)
124+
summary: Set a JSON-friendly object as the body of the request.
125+
syntax:
126+
content: set_json_body(data)
127+
parameters:
128+
- description: The request field data.
129+
id: data
130+
type: method
131+
uid: azure.core.HttpRequest.set_json_body
132+
- class: azure.core.HttpRequest
133+
fullName: azure.core.HttpRequest.set_streamed_data_body
134+
langs:
135+
- python
136+
module: azure.core
137+
name: set_streamed_data_body(data)
138+
summary: Set a streamable data body.
139+
syntax:
140+
content: set_streamed_data_body(data)
141+
parameters:
142+
- description: The request field data.
143+
id: data
144+
type: method
145+
uid: azure.core.HttpRequest.set_streamed_data_body
146+
- class: azure.core.HttpRequest
147+
fullName: azure.core.HttpRequest.set_xml_body
148+
langs:
149+
- python
150+
module: azure.core
151+
name: set_xml_body(data)
152+
summary: Set an XML element tree as the body of the request.
153+
syntax:
154+
content: set_xml_body(data)
155+
parameters:
156+
- description: The request field data.
157+
id: data
158+
type: method
159+
uid: azure.core.HttpRequest.set_xml_body
160+
references:
161+
- fullName: azure.core.HttpRequest.body
162+
isExternal: false
163+
name: body
164+
parent: azure.core.HttpRequest
165+
uid: azure.core.HttpRequest.body
166+
- fullName: azure.core.HttpRequest.format_parameters
167+
isExternal: false
168+
name: format_parameters(params)
169+
parent: azure.core.HttpRequest
170+
uid: azure.core.HttpRequest.format_parameters
171+
- fullName: azure.core.HttpRequest.query
172+
isExternal: false
173+
name: query
174+
parent: azure.core.HttpRequest
175+
uid: azure.core.HttpRequest.query
176+
- fullName: azure.core.HttpRequest.set_bytes_body
177+
isExternal: false
178+
name: set_bytes_body(data)
179+
parent: azure.core.HttpRequest
180+
uid: azure.core.HttpRequest.set_bytes_body
181+
- fullName: azure.core.HttpRequest.set_formdata_body
182+
isExternal: false
183+
name: set_formdata_body(data=None)
184+
parent: azure.core.HttpRequest
185+
uid: azure.core.HttpRequest.set_formdata_body
186+
- fullName: azure.core.HttpRequest.set_json_body
187+
isExternal: false
188+
name: set_json_body(data)
189+
parent: azure.core.HttpRequest
190+
uid: azure.core.HttpRequest.set_json_body
191+
- fullName: azure.core.HttpRequest.set_streamed_data_body
192+
isExternal: false
193+
name: set_streamed_data_body(data)
194+
parent: azure.core.HttpRequest
195+
uid: azure.core.HttpRequest.set_streamed_data_body
196+
- fullName: azure.core.HttpRequest.set_xml_body
197+
isExternal: false
198+
name: set_xml_body(data)
199+
parent: azure.core.HttpRequest
200+
uid: azure.core.HttpRequest.set_xml_body
201+
- fullName: dict[str,str]
202+
name: dict[str,str]
203+
spec.python:
204+
- fullName: dict
205+
name: dict
206+
uid: dict
207+
- fullName: '['
208+
name: '['
209+
- fullName: str,str
210+
name: str,str
211+
uid: str,str
212+
- fullName: ']'
213+
name: ']'
214+
uid: dict[str,str]

‎preview/docs-ref-autogen/azure-core/azure.core.HttpResponseError.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
### YamlMime:UniversalReference
2+
api_name: []
3+
items:
4+
- children: []
5+
class: azure.core.HttpResponseError
6+
fullName: azure.core.HttpResponseError
7+
inheritance:
8+
- inheritance:
9+
- inheritance:
10+
- inheritance:
11+
- type: builtins.object
12+
type: builtins.BaseException
13+
type: builtins.Exception
14+
type: azure.core.exceptions.AzureError
15+
langs:
16+
- python
17+
module: azure.core
18+
name: HttpResponseError
19+
summary: A request was made, and a non-success status code was received from the
20+
service.
21+
syntax:
22+
content: HttpResponseError(message=None, response=None, **kwargs)
23+
parameters:
24+
- description: HttpResponse's status code
25+
id: status_code
26+
- description: The response that triggered the exception.
27+
id: response
28+
type: class
29+
uid: azure.core.HttpResponseError
30+
references: []

‎preview/docs-ref-autogen/azure-core/azure.core.PipelineClient.yml

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
### YamlMime:UniversalReference
2+
api_name: []
3+
items:
4+
- children:
5+
- azure.core.PipelineClient.close
6+
class: azure.core.PipelineClient
7+
fullName: azure.core.PipelineClient
8+
inheritance:
9+
- inheritance:
10+
- type: builtins.object
11+
type: azure.core.pipeline.transport.base.PipelineClientBase
12+
langs:
13+
- python
14+
module: azure.core
15+
name: PipelineClient
16+
summary: 'Service client core methods.
17+
18+
19+
Builds a Pipeline client.
20+
21+
22+
**Keyword arguments:**
23+
24+
25+
*pipeline* - A Pipeline object. If omitted, a Pipeline object is created and returned.
26+
27+
28+
*transport* - The HTTP Transport type. If omitted, RequestsTransport is used for
29+
synchronous transport.'
30+
syntax:
31+
content: PipelineClient(base_url, config, **kwargs)
32+
parameters:
33+
- description: URL for the request.
34+
id: base_url
35+
type:
36+
- str
37+
- description: Service configuration. This is a required parameter.
38+
id: config
39+
type:
40+
- azure.core.Configuration
41+
- description: keyword arguments
42+
id: kwargs
43+
return:
44+
description: A pipeline object.
45+
type:
46+
- azure.core.pipeline.Pipeline
47+
type: class
48+
uid: azure.core.PipelineClient
49+
- class: azure.core.PipelineClient
50+
fullName: azure.core.PipelineClient.close
51+
langs:
52+
- python
53+
module: azure.core
54+
name: close()
55+
syntax:
56+
content: close()
57+
parameters: []
58+
type: method
59+
uid: azure.core.PipelineClient.close
60+
references:
61+
- fullName: azure.core.PipelineClient.close
62+
isExternal: false
63+
name: close()
64+
parent: azure.core.PipelineClient
65+
uid: azure.core.PipelineClient.close

0 commit comments

Comments
 (0)