-
Notifications
You must be signed in to change notification settings - Fork 180
/
Apis.yml
168 lines (168 loc) · 6.21 KB
/
Apis.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
### YamlMime:TSType
name: Apis
uid: '@azure/arm-apicenter.Apis'
package: '@azure/arm-apicenter'
summary: Interface representing a Apis.
fullName: Apis
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
createOrUpdate(string, string, string, string, Api,
ApisCreateOrUpdateOptionalParams)
uid: '@azure/arm-apicenter.Apis.createOrUpdate'
package: '@azure/arm-apicenter'
summary: Creates new or updates existing API.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceGroupName: string, serviceName: string,
workspaceName: string, apiName: string, resource: Api, options?:
ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: serviceName
type: string
description: The name of Azure API Center service.
- id: workspaceName
type: string
description: The name of the workspace.
- id: apiName
type: string
description: The name of the API.
- id: resource
type: <xref uid="@azure/arm-apicenter.Api" />
description: Resource create parameters.
- id: options
type: <xref uid="@azure/arm-apicenter.ApisCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-apicenter.ApisCreateOrUpdateResponse"
/>>
- name: delete(string, string, string, string, ApisDeleteOptionalParams)
uid: '@azure/arm-apicenter.Apis.delete'
package: '@azure/arm-apicenter'
summary: Deletes specified API.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, serviceName: string,
workspaceName: string, apiName: string, options?:
ApisDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: serviceName
type: string
description: The name of Azure API Center service.
- id: workspaceName
type: string
description: The name of the workspace.
- id: apiName
type: string
description: The name of the API.
- id: options
type: <xref uid="@azure/arm-apicenter.ApisDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, string, ApisGetOptionalParams)
uid: '@azure/arm-apicenter.Apis.get'
package: '@azure/arm-apicenter'
summary: Returns details of the API.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, serviceName: string,
workspaceName: string, apiName: string, options?:
ApisGetOptionalParams): Promise<ApisGetResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: serviceName
type: string
description: The name of Azure API Center service.
- id: workspaceName
type: string
description: The name of the workspace.
- id: apiName
type: string
description: The name of the API.
- id: options
type: <xref uid="@azure/arm-apicenter.ApisGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-apicenter.ApisGetResponse" />>
- name: head(string, string, string, string, ApisHeadOptionalParams)
uid: '@azure/arm-apicenter.Apis.head'
package: '@azure/arm-apicenter'
summary: Checks if specified API exists.
remarks: ''
isDeprecated: false
syntax:
content: >-
function head(resourceGroupName: string, serviceName: string,
workspaceName: string, apiName: string, options?:
ApisHeadOptionalParams): Promise<ApisHeadResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: serviceName
type: string
description: The name of Azure API Center service.
- id: workspaceName
type: string
description: The name of the workspace.
- id: apiName
type: string
description: The name of the API.
- id: options
type: <xref uid="@azure/arm-apicenter.ApisHeadOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-apicenter.ApisHeadResponse" />>
- name: list(string, string, string, ApisListOptionalParams)
uid: '@azure/arm-apicenter.Apis.list'
package: '@azure/arm-apicenter'
summary: Returns a collection of APIs.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, serviceName: string,
workspaceName: string, options?: ApisListOptionalParams):
PagedAsyncIterableIterator<Api, Api[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: serviceName
type: string
description: The name of Azure API Center service.
- id: workspaceName
type: string
description: The name of the workspace.
- id: options
type: <xref uid="@azure/arm-apicenter.ApisListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-apicenter.Api" />, <xref
uid="@azure/arm-apicenter.Api" />[], <xref
uid="@azure/core-paging.PageSettings" />>