/
Service.yml
197 lines (197 loc) · 7.61 KB
/
Service.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
### YamlMime:TSType
name: Service
uid: '@azure/arm-cosmosdb.Service'
package: '@azure/arm-cosmosdb'
summary: Interface representing a Service.
fullName: Service
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreate(string, string, string, ServiceResourceCreateUpdateParameters,
ServiceCreateOptionalParams)
uid: '@azure/arm-cosmosdb.Service.beginCreate'
package: '@azure/arm-cosmosdb'
summary: Creates a service.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreate(resourceGroupName: string, accountName: string,
serviceName: string, createUpdateParameters:
ServiceResourceCreateUpdateParameters, options?:
ServiceCreateOptionalParams):
Promise<SimplePollerLike<OperationState<ServiceResource>,
ServiceResource>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: accountName
type: string
description: Cosmos DB database account name.
- id: serviceName
type: string
description: Cosmos DB service name.
- id: createUpdateParameters
type: >-
<xref
uid="@azure/arm-cosmosdb.ServiceResourceCreateUpdateParameters" />
description: The Service resource parameters.
- id: options
type: <xref uid="@azure/arm-cosmosdb.ServiceCreateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-cosmosdb.ServiceResource" />>, <xref
uid="@azure/arm-cosmosdb.ServiceResource" />>>
- name: >-
beginCreateAndWait(string, string, string,
ServiceResourceCreateUpdateParameters, ServiceCreateOptionalParams)
uid: '@azure/arm-cosmosdb.Service.beginCreateAndWait'
package: '@azure/arm-cosmosdb'
summary: Creates a service.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateAndWait(resourceGroupName: string, accountName:
string, serviceName: string, createUpdateParameters:
ServiceResourceCreateUpdateParameters, options?:
ServiceCreateOptionalParams): Promise<ServiceResource>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: accountName
type: string
description: Cosmos DB database account name.
- id: serviceName
type: string
description: Cosmos DB service name.
- id: createUpdateParameters
type: >-
<xref
uid="@azure/arm-cosmosdb.ServiceResourceCreateUpdateParameters" />
description: The Service resource parameters.
- id: options
type: <xref uid="@azure/arm-cosmosdb.ServiceCreateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-cosmosdb.ServiceResource" />>
- name: beginDelete(string, string, string, ServiceDeleteOptionalParams)
uid: '@azure/arm-cosmosdb.Service.beginDelete'
package: '@azure/arm-cosmosdb'
summary: Deletes service with the given serviceName.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, accountName: string,
serviceName: string, options?: ServiceDeleteOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: accountName
type: string
description: Cosmos DB database account name.
- id: serviceName
type: string
description: Cosmos DB service name.
- id: options
type: <xref uid="@azure/arm-cosmosdb.ServiceDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><void>, void>>
- name: beginDeleteAndWait(string, string, string, ServiceDeleteOptionalParams)
uid: '@azure/arm-cosmosdb.Service.beginDeleteAndWait'
package: '@azure/arm-cosmosdb'
summary: Deletes service with the given serviceName.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, accountName:
string, serviceName: string, options?: ServiceDeleteOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: accountName
type: string
description: Cosmos DB database account name.
- id: serviceName
type: string
description: Cosmos DB service name.
- id: options
type: <xref uid="@azure/arm-cosmosdb.ServiceDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, ServiceGetOptionalParams)
uid: '@azure/arm-cosmosdb.Service.get'
package: '@azure/arm-cosmosdb'
summary: Gets the status of service.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, accountName: string,
serviceName: string, options?: ServiceGetOptionalParams):
Promise<ServiceResource>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: accountName
type: string
description: Cosmos DB database account name.
- id: serviceName
type: string
description: Cosmos DB service name.
- id: options
type: <xref uid="@azure/arm-cosmosdb.ServiceGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-cosmosdb.ServiceResource" />>
- name: list(string, string, ServiceListOptionalParams)
uid: '@azure/arm-cosmosdb.Service.list'
package: '@azure/arm-cosmosdb'
summary: Gets the status of service.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, accountName: string, options?:
ServiceListOptionalParams): PagedAsyncIterableIterator<ServiceResource,
ServiceResource[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: accountName
type: string
description: Cosmos DB database account name.
- id: options
type: <xref uid="@azure/arm-cosmosdb.ServiceListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-cosmosdb.ServiceResource" />, <xref
uid="@azure/arm-cosmosdb.ServiceResource" />[], <xref
uid="@azure/core-paging.PageSettings" />>