Skip to content

Commit 895f049

Browse files
committed
Update Help Files
1 parent bdaba8e commit 895f049

File tree

2 files changed

+221
-3
lines changed

2 files changed

+221
-3
lines changed

src/ApiManagement/ApiManagement/help/New-AzApiManagementApi.md

Lines changed: 110 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ New-AzApiManagementApi -Context <PsApiManagementContext> [-ApiId <String>] -Name
2020
[-BearerTokenSendingMethod <String[]>] [-SubscriptionKeyHeaderName <String>]
2121
[-SubscriptionKeyQueryParamName <String>] [-ProductIds <String[]>] [-SubscriptionRequired]
2222
[-ApiVersionDescription <String>] [-ApiVersionSetId <String>] [-ApiVersion <String>] [-SourceApiId <String>]
23-
[-SourceApiRevision <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
23+
[-SourceApiRevision <String>] [-ApiType <PsApiManagementApiType>] [-TermsOfServiceUrl <String>]
24+
[-ContactName <String>] [-ContactUrl <String>] [-ContactEmail <String>] [-LicenseName <String>]
25+
[-LicenseUrl <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2426
```
2527

2628
## DESCRIPTION
@@ -99,6 +101,22 @@ Accept pipeline input: True (ByPropertyName)
99101
Accept wildcard characters: False
100102
```
101103
104+
### -ApiType
105+
Type of API to create (http, soap, websocket, graphql). This parameter is optional.
106+
107+
```yaml
108+
Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType]
109+
Parameter Sets: (All)
110+
Aliases:
111+
Accepted values: Http, Soap, WebSocket, GraphQL
112+
113+
Required: False
114+
Position: Named
115+
Default value: None
116+
Accept pipeline input: True (ByPropertyName)
117+
Accept wildcard characters: False
118+
```
119+
102120
### -ApiVersion
103121
Api Version of the Api to create. This parameter is optional.
104122
@@ -192,6 +210,51 @@ Accept pipeline input: True (ByPropertyName)
192210
Accept wildcard characters: False
193211
```
194212
213+
### -ContactEmail
214+
The email address of the contact person/organization. MUST be in the format of an email address. This parameter is optional.
215+
216+
```yaml
217+
Type: System.String
218+
Parameter Sets: (All)
219+
Aliases:
220+
221+
Required: False
222+
Position: Named
223+
Default value: None
224+
Accept pipeline input: True (ByPropertyName)
225+
Accept wildcard characters: False
226+
```
227+
228+
### -ContactName
229+
The identifying name of the contact person/organization. This parameter is optional.
230+
231+
```yaml
232+
Type: System.String
233+
Parameter Sets: (All)
234+
Aliases:
235+
236+
Required: False
237+
Position: Named
238+
Default value: None
239+
Accept pipeline input: True (ByPropertyName)
240+
Accept wildcard characters: False
241+
```
242+
243+
### -ContactUrl
244+
The URL pointing to the contact information. MUST be in the format of a URL. This parameter is optional.
245+
246+
```yaml
247+
Type: System.String
248+
Parameter Sets: (All)
249+
Aliases:
250+
251+
Required: False
252+
Position: Named
253+
Default value: None
254+
Accept pipeline input: True (ByPropertyName)
255+
Accept wildcard characters: False
256+
```
257+
195258
### -Context
196259
Specifies a **PsApiManagementContext** object.
197260
@@ -237,6 +300,36 @@ Accept pipeline input: True (ByPropertyName)
237300
Accept wildcard characters: False
238301
```
239302
303+
### -LicenseName
304+
The license name used for the API. This parameter is optional.
305+
306+
```yaml
307+
Type: System.String
308+
Parameter Sets: (All)
309+
Aliases:
310+
311+
Required: False
312+
Position: Named
313+
Default value: None
314+
Accept pipeline input: True (ByPropertyName)
315+
Accept wildcard characters: False
316+
```
317+
318+
### -LicenseUrl
319+
A URL to the Terms of Service for the API. This parameter is optional.
320+
321+
```yaml
322+
Type: System.String
323+
Parameter Sets: (All)
324+
Aliases:
325+
326+
Required: False
327+
Position: Named
328+
Default value: None
329+
Accept pipeline input: True (ByPropertyName)
330+
Accept wildcard characters: False
331+
```
332+
240333
### -Name
241334
Specifies the name of the web API.
242335
This is the public name of the API as it appears on the developer and admin portals.
@@ -310,7 +403,7 @@ The default value is $Null.
310403
Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[]
311404
Parameter Sets: (All)
312405
Aliases:
313-
Accepted values: Http, Https
406+
Accepted values: Http, Https, Ws, Wss
314407

315408
Required: True
316409
Position: Named
@@ -413,6 +506,21 @@ Accept pipeline input: True (ByPropertyName)
413506
Accept wildcard characters: False
414507
```
415508
509+
### -TermsOfServiceUrl
510+
A URL to the Terms of Service for the API. This parameter is optional.
511+
512+
```yaml
513+
Type: System.String
514+
Parameter Sets: (All)
515+
Aliases:
516+
517+
Required: False
518+
Position: Named
519+
Default value: None
520+
Accept pipeline input: True (ByPropertyName)
521+
Accept wildcard characters: False
522+
```
523+
416524
### CommonParameters
417525
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
418526

src/ApiManagement/ApiManagement/help/Set-AzApiManagementApi.md

Lines changed: 111 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Set-AzApiManagementApi -Context <PsApiManagementContext> -ApiId <String> [-Name
2020
[-AuthorizationServerId <String>] [-AuthorizationScope <String>] [-OpenIdProviderId <String>]
2121
[-BearerTokenSendingMethod <String[]>] [-SubscriptionKeyHeaderName <String>]
2222
[-SubscriptionKeyQueryParamName <String>] [-SubscriptionRequired] [-PassThru]
23+
[-ApiType <PsApiManagementApiType>] [-TermsOfServiceUrl <String>] [-ContactName <String>]
24+
[-ContactUrl <String>] [-ContactEmail <String>] [-LicenseName <String>] [-LicenseUrl <String>]
2325
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2426
```
2527

@@ -30,6 +32,8 @@ Set-AzApiManagementApi -InputObject <PsApiManagementApi> [-Name <String>] [-Desc
3032
[-AuthorizationServerId <String>] [-AuthorizationScope <String>] [-OpenIdProviderId <String>]
3133
[-BearerTokenSendingMethod <String[]>] [-SubscriptionKeyHeaderName <String>]
3234
[-SubscriptionKeyQueryParamName <String>] [-SubscriptionRequired] [-PassThru]
35+
[-ApiType <PsApiManagementApiType>] [-TermsOfServiceUrl <String>] [-ContactName <String>]
36+
[-ContactUrl <String>] [-ContactEmail <String>] [-LicenseName <String>] [-LicenseUrl <String>]
3337
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3438
```
3539

@@ -83,6 +87,22 @@ Accept pipeline input: True (ByPropertyName)
8387
Accept wildcard characters: False
8488
```
8589
90+
### -ApiType
91+
Type of API to create (http, soap, websocket, graphql). This parameter is optional.
92+
93+
```yaml
94+
Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType]
95+
Parameter Sets: (All)
96+
Aliases:
97+
Accepted values: Http, Soap, WebSocket, GraphQL
98+
99+
Required: False
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: True (ByPropertyName)
103+
Accept wildcard characters: False
104+
```
105+
86106
### -AuthorizationScope
87107
Specifies the OAuth operations scope.
88108
The default value is $Null.
@@ -131,6 +151,51 @@ Accept pipeline input: True (ByPropertyName)
131151
Accept wildcard characters: False
132152
```
133153
154+
### -ContactEmail
155+
The email address of the contact person/organization. MUST be in the format of an email address. This parameter is optional.
156+
157+
```yaml
158+
Type: System.String
159+
Parameter Sets: (All)
160+
Aliases:
161+
162+
Required: False
163+
Position: Named
164+
Default value: None
165+
Accept pipeline input: True (ByPropertyName)
166+
Accept wildcard characters: False
167+
```
168+
169+
### -ContactName
170+
The identifying name of the contact person/organization. This parameter is optional.
171+
172+
```yaml
173+
Type: System.String
174+
Parameter Sets: (All)
175+
Aliases:
176+
177+
Required: False
178+
Position: Named
179+
Default value: None
180+
Accept pipeline input: True (ByPropertyName)
181+
Accept wildcard characters: False
182+
```
183+
184+
### -ContactUrl
185+
The URL pointing to the contact information. MUST be in the format of a URL. This parameter is optional.
186+
187+
```yaml
188+
Type: System.String
189+
Parameter Sets: (All)
190+
Aliases:
191+
192+
Required: False
193+
Position: Named
194+
Default value: None
195+
Accept pipeline input: True (ByPropertyName)
196+
Accept wildcard characters: False
197+
```
198+
134199
### -Context
135200
Specifies a **PsApiManagementContext** object.
136201
@@ -191,6 +256,36 @@ Accept pipeline input: True (ByValue)
191256
Accept wildcard characters: False
192257
```
193258
259+
### -LicenseName
260+
The license name used for the API. This parameter is optional.
261+
262+
```yaml
263+
Type: System.String
264+
Parameter Sets: (All)
265+
Aliases:
266+
267+
Required: False
268+
Position: Named
269+
Default value: None
270+
Accept pipeline input: True (ByPropertyName)
271+
Accept wildcard characters: False
272+
```
273+
274+
### -LicenseUrl
275+
A URL to the Terms of Service for the API. This parameter is optional.
276+
277+
```yaml
278+
Type: System.String
279+
Parameter Sets: (All)
280+
Aliases:
281+
282+
Required: False
283+
Position: Named
284+
Default value: None
285+
Accept pipeline input: True (ByPropertyName)
286+
Accept wildcard characters: False
287+
```
288+
194289
### -Name
195290
Specifies the name of the web API.
196291
@@ -263,7 +358,7 @@ The default value is $Null.
263358
Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[]
264359
Parameter Sets: (All)
265360
Aliases:
266-
Accepted values: Http, Https
361+
Accepted values: Http, Https, Ws, Wss
267362

268363
Required: False
269364
Position: Named
@@ -336,6 +431,21 @@ Accept pipeline input: True (ByPropertyName)
336431
Accept wildcard characters: False
337432
```
338433
434+
### -TermsOfServiceUrl
435+
A URL to the Terms of Service for the API. This parameter is optional.
436+
437+
```yaml
438+
Type: System.String
439+
Parameter Sets: (All)
440+
Aliases:
441+
442+
Required: False
443+
Position: Named
444+
Default value: None
445+
Accept pipeline input: True (ByPropertyName)
446+
Accept wildcard characters: False
447+
```
448+
339449
### CommonParameters
340450
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
341451

0 commit comments

Comments
 (0)