-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.yml
703 lines (703 loc) · 56.2 KB
/
com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
### YamlMime:JavaType
uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource"
name: "ApiManagementServiceResource"
nameWithType: "ApiManagementServiceResource"
summary: "An immutable client-side representation of Api<wbr>Management<wbr>Service<wbr>Resource."
syntax: "public interface **ApiManagementServiceResource**"
methods:
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.additionalLocations()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.additionalLocations()"
name: "additionalLocations()"
nameWithType: "ApiManagementServiceResource.additionalLocations()"
summary: "Gets the additional<wbr>Locations property: Additional datacenter locations of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract List<AdditionalLocation> additionalLocations()"
desc: "Gets the additionalLocations property: Additional datacenter locations of the API Management service."
returns:
description: "the additionalLocations value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.apimanagement.models.AdditionalLocation?alt=com.azure.resourcemanager.apimanagement.models.AdditionalLocation&text=AdditionalLocation\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.apiVersionConstraint()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.apiVersionConstraint()"
name: "apiVersionConstraint()"
nameWithType: "ApiManagementServiceResource.apiVersionConstraint()"
summary: "Gets the api<wbr>Version<wbr>Constraint property: Control Plane Apis version constraint for the API Management service."
modifiers:
- "abstract"
syntax: "public abstract ApiVersionConstraint apiVersionConstraint()"
desc: "Gets the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service."
returns:
description: "the apiVersionConstraint value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiVersionConstraint?alt=com.azure.resourcemanager.apimanagement.models.ApiVersionConstraint&text=ApiVersionConstraint\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.applyNetworkConfigurationUpdates()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.applyNetworkConfigurationUpdates()"
name: "applyNetworkConfigurationUpdates()"
nameWithType: "ApiManagementServiceResource.applyNetworkConfigurationUpdates()"
summary: "Updates the Microsoft.<wbr>Api<wbr>Management resource running in the Virtual network to pick the updated DNS changes."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceResource applyNetworkConfigurationUpdates()"
desc: "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes."
returns:
description: "a single API Management service resource in List or Get response."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.applyNetworkConfigurationUpdates(com.azure.resourcemanager.apimanagement.models.ApiManagementServiceApplyNetworkConfigurationParameters,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.applyNetworkConfigurationUpdates(ApiManagementServiceApplyNetworkConfigurationParameters parameters, Context context)"
name: "applyNetworkConfigurationUpdates(ApiManagementServiceApplyNetworkConfigurationParameters parameters, Context context)"
nameWithType: "ApiManagementServiceResource.applyNetworkConfigurationUpdates(ApiManagementServiceApplyNetworkConfigurationParameters parameters, Context context)"
summary: "Updates the Microsoft.<wbr>Api<wbr>Management resource running in the Virtual network to pick the updated DNS changes."
modifiers:
- "abstract"
parameters:
- description: "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty,\n all the regions in which the Api Management service is deployed will be updated sequentially without\n incurring downtime in the region."
name: "parameters"
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceApplyNetworkConfigurationParameters?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceApplyNetworkConfigurationParameters&text=ApiManagementServiceApplyNetworkConfigurationParameters\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ApiManagementServiceResource applyNetworkConfigurationUpdates(ApiManagementServiceApplyNetworkConfigurationParameters parameters, Context context)"
desc: "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes."
returns:
description: "a single API Management service resource in List or Get response."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.backup(com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters)"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.backup(ApiManagementServiceBackupRestoreParameters parameters)"
name: "backup(ApiManagementServiceBackupRestoreParameters parameters)"
nameWithType: "ApiManagementServiceResource.backup(ApiManagementServiceBackupRestoreParameters parameters)"
summary: "Creates a backup of the API Management service to the given Azure Storage Account."
modifiers:
- "abstract"
parameters:
- description: "Parameters supplied to the ApiManagementService_Backup operation."
name: "parameters"
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters&text=ApiManagementServiceBackupRestoreParameters\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ApiManagementServiceResource backup(ApiManagementServiceBackupRestoreParameters parameters)"
desc: "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete."
returns:
description: "a single API Management service resource in List or Get response."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.backup(com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.backup(ApiManagementServiceBackupRestoreParameters parameters, Context context)"
name: "backup(ApiManagementServiceBackupRestoreParameters parameters, Context context)"
nameWithType: "ApiManagementServiceResource.backup(ApiManagementServiceBackupRestoreParameters parameters, Context context)"
summary: "Creates a backup of the API Management service to the given Azure Storage Account."
modifiers:
- "abstract"
parameters:
- description: "Parameters supplied to the ApiManagementService_Backup operation."
name: "parameters"
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters&text=ApiManagementServiceBackupRestoreParameters\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ApiManagementServiceResource backup(ApiManagementServiceBackupRestoreParameters parameters, Context context)"
desc: "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete."
returns:
description: "a single API Management service resource in List or Get response."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.certificates()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.certificates()"
name: "certificates()"
nameWithType: "ApiManagementServiceResource.certificates()"
summary: "Gets the certificates property: List of Certificates that need to be installed in the API Management service."
modifiers:
- "abstract"
syntax: "public abstract List<CertificateConfiguration> certificates()"
desc: "Gets the certificates property: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10."
returns:
description: "the certificates value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.apimanagement.models.CertificateConfiguration?alt=com.azure.resourcemanager.apimanagement.models.CertificateConfiguration&text=CertificateConfiguration\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.createdAtUtc()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.createdAtUtc()"
name: "createdAtUtc()"
nameWithType: "ApiManagementServiceResource.createdAtUtc()"
summary: "Gets the created<wbr>AtUtc property: Creation UTC date of the API Management service.<wbr>The date conforms to the following format: \\`yyyy-MM-ddTHH:mm:ssZ\\` as specified by the ISO 8601 standard."
modifiers:
- "abstract"
syntax: "public abstract OffsetDateTime createdAtUtc()"
desc: "Gets the createdAtUtc property: Creation UTC date of the API Management service.The date conforms to the following format: \\`yyyy-MM-ddTHH:mm:ssZ\\` as specified by the ISO 8601 standard."
returns:
description: "the createdAtUtc value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.customProperties()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.customProperties()"
name: "customProperties()"
nameWithType: "ApiManagementServiceResource.customProperties()"
summary: "Gets the custom<wbr>Properties property: Custom properties of the API Management service.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Ciphers.<wbr>Triple<wbr>Des168\\` will disable the cipher TLS\\_RSA\\_WITH\\_3DES\\_EDE\\_CBC\\_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Protocols.<wbr>Tls11\\` can be used to disable just TLS 1.1.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Protocols.<wbr>Tls10\\` can be used to disable TLS 1.0 on an API Management service.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Backend.<wbr>Protocols.<wbr>Tls11\\` can be used to disable just TLS 1.1 for communications with backends.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Backend.<wbr>Protocols.<wbr>Tls10\\` can be used to disable TLS 1.0 for communications with backends.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Protocols.<wbr>Server.<wbr>Http2\\` can be used to enable HTTP2 protocol on an API Management service.</br>Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults."
modifiers:
- "abstract"
syntax: "public abstract Map<String,String> customProperties()"
desc: "Gets the customProperties property: Custom properties of the API Management service.</br>Setting \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168\\` will disable the cipher TLS\\_RSA\\_WITH\\_3DES\\_EDE\\_CBC\\_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11\\` can be used to disable just TLS 1.1.</br>Setting \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10\\` can be used to disable TLS 1.0 on an API Management service.</br>Setting \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11\\` can be used to disable just TLS 1.1 for communications with backends.</br>Setting \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10\\` can be used to disable TLS 1.0 for communications with backends.</br>Setting \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2\\` can be used to enable HTTP2 protocol on an API Management service.</br>Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is \\`True\\` if the service was created on or before April 1, 2018 and \\`False\\` otherwise. Http2 setting's default value is \\`False\\`.</br></br>You can disable any of the following ciphers by using settings \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.\\[cipher\\_name\\]\\`: TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_256\\_CBC\\_SHA, TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_128\\_CBC\\_SHA, TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA, TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA, TLS\\_RSA\\_WITH\\_AES\\_128\\_GCM\\_SHA256, TLS\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA256, TLS\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA256, TLS\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA, TLS\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA. For example, \\`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA256\\`:\\`false\\`. The default value is \\`true\\` for them.</br> Note: The following ciphers can't be disabled since they are required by internal platform components: TLS\\_AES\\_256\\_GCM\\_SHA384,TLS\\_AES\\_128\\_GCM\\_SHA256,TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_256\\_GCM\\_SHA384,TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_128\\_GCM\\_SHA256,TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_256\\_GCM\\_SHA384,TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_128\\_GCM\\_SHA256,TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_256\\_CBC\\_SHA384,TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_128\\_CBC\\_SHA256,TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA384,TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA256."
returns:
description: "the customProperties value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.developerPortalUrl()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.developerPortalUrl()"
name: "developerPortalUrl()"
nameWithType: "ApiManagementServiceResource.developerPortalUrl()"
summary: "Gets the developer<wbr>Portal<wbr>Url property: DEveloper Portal endpoint URL of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract String developerPortalUrl()"
desc: "Gets the developerPortalUrl property: DEveloper Portal endpoint URL of the API Management service."
returns:
description: "the developerPortalUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.disableGateway()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.disableGateway()"
name: "disableGateway()"
nameWithType: "ApiManagementServiceResource.disableGateway()"
summary: "Gets the disable<wbr>Gateway property: Property only valid for an Api Management service deployed in multiple locations."
modifiers:
- "abstract"
syntax: "public abstract Boolean disableGateway()"
desc: "Gets the disableGateway property: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region."
returns:
description: "the disableGateway value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.enableClientCertificate()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.enableClientCertificate()"
name: "enableClientCertificate()"
nameWithType: "ApiManagementServiceResource.enableClientCertificate()"
summary: "Gets the enable<wbr>Client<wbr>Certificate property: Property only meant to be used for Consumption SKU Service."
modifiers:
- "abstract"
syntax: "public abstract Boolean enableClientCertificate()"
desc: "Gets the enableClientCertificate property: Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway."
returns:
description: "the enableClientCertificate value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.etag()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.etag()"
name: "etag()"
nameWithType: "ApiManagementServiceResource.etag()"
summary: "Gets the etag property: ETag of the resource."
modifiers:
- "abstract"
syntax: "public abstract String etag()"
desc: "Gets the etag property: ETag of the resource."
returns:
description: "the etag value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.gatewayRegionalUrl()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.gatewayRegionalUrl()"
name: "gatewayRegionalUrl()"
nameWithType: "ApiManagementServiceResource.gatewayRegionalUrl()"
summary: "Gets the gateway<wbr>Regional<wbr>Url property: Gateway URL of the API Management service in the Default Region."
modifiers:
- "abstract"
syntax: "public abstract String gatewayRegionalUrl()"
desc: "Gets the gatewayRegionalUrl property: Gateway URL of the API Management service in the Default Region."
returns:
description: "the gatewayRegionalUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.gatewayUrl()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.gatewayUrl()"
name: "gatewayUrl()"
nameWithType: "ApiManagementServiceResource.gatewayUrl()"
summary: "Gets the gateway<wbr>Url property: Gateway URL of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract String gatewayUrl()"
desc: "Gets the gatewayUrl property: Gateway URL of the API Management service."
returns:
description: "the gatewayUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.getSsoToken()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.getSsoToken()"
name: "getSsoToken()"
nameWithType: "ApiManagementServiceResource.getSsoToken()"
summary: "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceGetSsoTokenResult getSsoToken()"
desc: "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes."
returns:
description: "the Single-Sign-On token for the API Management Service which is valid for 5 Minutes."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceGetSsoTokenResult?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceGetSsoTokenResult&text=ApiManagementServiceGetSsoTokenResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.getSsoTokenWithResponse(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.getSsoTokenWithResponse(Context context)"
name: "getSsoTokenWithResponse(Context context)"
nameWithType: "ApiManagementServiceResource.getSsoTokenWithResponse(Context context)"
summary: "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes."
modifiers:
- "abstract"
parameters:
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<ApiManagementServiceGetSsoTokenResult> getSsoTokenWithResponse(Context context)"
desc: "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes."
returns:
description: "the Single-Sign-On token for the API Management Service which is valid for 5 Minutes along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceGetSsoTokenResult?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceGetSsoTokenResult&text=ApiManagementServiceGetSsoTokenResult\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.hostnameConfigurations()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.hostnameConfigurations()"
name: "hostnameConfigurations()"
nameWithType: "ApiManagementServiceResource.hostnameConfigurations()"
summary: "Gets the hostname<wbr>Configurations property: Custom hostname configuration of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract List<HostnameConfiguration> hostnameConfigurations()"
desc: "Gets the hostnameConfigurations property: Custom hostname configuration of the API Management service."
returns:
description: "the hostnameConfigurations value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.apimanagement.models.HostnameConfiguration?alt=com.azure.resourcemanager.apimanagement.models.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.id()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.id()"
name: "id()"
nameWithType: "ApiManagementServiceResource.id()"
summary: "Gets the id property: Fully qualified resource Id for the resource."
modifiers:
- "abstract"
syntax: "public abstract String id()"
desc: "Gets the id property: Fully qualified resource Id for the resource."
returns:
description: "the id value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.identity()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.identity()"
name: "identity()"
nameWithType: "ApiManagementServiceResource.identity()"
summary: "Gets the identity property: Managed service identity of the Api Management service."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceIdentity identity()"
desc: "Gets the identity property: Managed service identity of the Api Management service."
returns:
description: "the identity value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceIdentity?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceIdentity&text=ApiManagementServiceIdentity\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.innerModel()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.innerModel()"
name: "innerModel()"
nameWithType: "ApiManagementServiceResource.innerModel()"
summary: "Gets the inner com.<wbr>azure.<wbr>resourcemanager.<wbr>apimanagement.<wbr>fluent.<wbr>models.<wbr>Api<wbr>Management<wbr>Service<wbr>Resource<wbr>Inner object."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceResourceInner innerModel()"
desc: "Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceResourceInner object."
returns:
description: "the inner object."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceResourceInner?alt=com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceResourceInner&text=ApiManagementServiceResourceInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.location()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.location()"
name: "location()"
nameWithType: "ApiManagementServiceResource.location()"
summary: "Gets the location property: Resource location."
modifiers:
- "abstract"
syntax: "public abstract String location()"
desc: "Gets the location property: Resource location."
returns:
description: "the location value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.managementApiUrl()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.managementApiUrl()"
name: "managementApiUrl()"
nameWithType: "ApiManagementServiceResource.managementApiUrl()"
summary: "Gets the management<wbr>Api<wbr>Url property: Management API endpoint URL of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract String managementApiUrl()"
desc: "Gets the managementApiUrl property: Management API endpoint URL of the API Management service."
returns:
description: "the managementApiUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.migrateToStv2()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.migrateToStv2()"
name: "migrateToStv2()"
nameWithType: "ApiManagementServiceResource.migrateToStv2()"
summary: "Upgrades an API Management service to the Stv2 platform."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceResource migrateToStv2()"
desc: "Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete."
returns:
description: "a single API Management service resource in List or Get response."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.migrateToStv2(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.migrateToStv2(Context context)"
name: "migrateToStv2(Context context)"
nameWithType: "ApiManagementServiceResource.migrateToStv2(Context context)"
summary: "Upgrades an API Management service to the Stv2 platform."
modifiers:
- "abstract"
parameters:
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ApiManagementServiceResource migrateToStv2(Context context)"
desc: "Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete."
returns:
description: "a single API Management service resource in List or Get response."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.name()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.name()"
name: "name()"
nameWithType: "ApiManagementServiceResource.name()"
summary: "Gets the name property: The name of the resource."
modifiers:
- "abstract"
syntax: "public abstract String name()"
desc: "Gets the name property: The name of the resource."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.natGatewayState()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.natGatewayState()"
name: "natGatewayState()"
nameWithType: "ApiManagementServiceResource.natGatewayState()"
summary: "Gets the nat<wbr>Gateway<wbr>State property: Property can be used to enable NAT Gateway for this API Management service."
modifiers:
- "abstract"
syntax: "public abstract NatGatewayState natGatewayState()"
desc: "Gets the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service."
returns:
description: "the natGatewayState value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.NatGatewayState?alt=com.azure.resourcemanager.apimanagement.models.NatGatewayState&text=NatGatewayState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.notificationSenderEmail()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.notificationSenderEmail()"
name: "notificationSenderEmail()"
nameWithType: "ApiManagementServiceResource.notificationSenderEmail()"
summary: "Gets the notification<wbr>Sender<wbr>Email property: Email address from which the notification will be sent."
modifiers:
- "abstract"
syntax: "public abstract String notificationSenderEmail()"
desc: "Gets the notificationSenderEmail property: Email address from which the notification will be sent."
returns:
description: "the notificationSenderEmail value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.outboundPublicIpAddresses()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.outboundPublicIpAddresses()"
name: "outboundPublicIpAddresses()"
nameWithType: "ApiManagementServiceResource.outboundPublicIpAddresses()"
summary: "Gets the outbound<wbr>Public<wbr>IpAddresses property: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service."
modifiers:
- "abstract"
syntax: "public abstract List<String> outboundPublicIpAddresses()"
desc: "Gets the outboundPublicIpAddresses property: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform."
returns:
description: "the outboundPublicIpAddresses value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.platformVersion()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.platformVersion()"
name: "platformVersion()"
nameWithType: "ApiManagementServiceResource.platformVersion()"
summary: "Gets the platform<wbr>Version property: Compute Platform Version running the service in this location."
modifiers:
- "abstract"
syntax: "public abstract PlatformVersion platformVersion()"
desc: "Gets the platformVersion property: Compute Platform Version running the service in this location."
returns:
description: "the platformVersion value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.PlatformVersion?alt=com.azure.resourcemanager.apimanagement.models.PlatformVersion&text=PlatformVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.portalUrl()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.portalUrl()"
name: "portalUrl()"
nameWithType: "ApiManagementServiceResource.portalUrl()"
summary: "Gets the portal<wbr>Url property: Publisher portal endpoint Url of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract String portalUrl()"
desc: "Gets the portalUrl property: Publisher portal endpoint Url of the API Management service."
returns:
description: "the portalUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.privateEndpointConnections()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.privateEndpointConnections()"
name: "privateEndpointConnections()"
nameWithType: "ApiManagementServiceResource.privateEndpointConnections()"
summary: "Gets the private<wbr>Endpoint<wbr>Connections property: List of Private Endpoint Connections of this service."
modifiers:
- "abstract"
syntax: "public abstract List<RemotePrivateEndpointConnectionWrapper> privateEndpointConnections()"
desc: "Gets the privateEndpointConnections property: List of Private Endpoint Connections of this service."
returns:
description: "the privateEndpointConnections value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.apimanagement.models.RemotePrivateEndpointConnectionWrapper?alt=com.azure.resourcemanager.apimanagement.models.RemotePrivateEndpointConnectionWrapper&text=RemotePrivateEndpointConnectionWrapper\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.privateIpAddresses()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.privateIpAddresses()"
name: "privateIpAddresses()"
nameWithType: "ApiManagementServiceResource.privateIpAddresses()"
summary: "Gets the private<wbr>IpAddresses property: Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network."
modifiers:
- "abstract"
syntax: "public abstract List<String> privateIpAddresses()"
desc: "Gets the privateIpAddresses property: Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU."
returns:
description: "the privateIpAddresses value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.provisioningState()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.provisioningState()"
name: "provisioningState()"
nameWithType: "ApiManagementServiceResource.provisioningState()"
summary: "Gets the provisioning<wbr>State property: The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/Termination<wbr>Failed/Deleted."
modifiers:
- "abstract"
syntax: "public abstract String provisioningState()"
desc: "Gets the provisioningState property: The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted."
returns:
description: "the provisioningState value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publicIpAddressId()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publicIpAddressId()"
name: "publicIpAddressId()"
nameWithType: "ApiManagementServiceResource.publicIpAddressId()"
summary: "Gets the public<wbr>IpAddress<wbr>Id property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region."
modifiers:
- "abstract"
syntax: "public abstract String publicIpAddressId()"
desc: "Gets the publicIpAddressId property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network."
returns:
description: "the publicIpAddressId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publicIpAddresses()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publicIpAddresses()"
name: "publicIpAddresses()"
nameWithType: "ApiManagementServiceResource.publicIpAddresses()"
summary: "Gets the public<wbr>IpAddresses property: Public Static Load Balanced IP addresses of the API Management service in Primary region."
modifiers:
- "abstract"
syntax: "public abstract List<String> publicIpAddresses()"
desc: "Gets the publicIpAddresses property: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU."
returns:
description: "the publicIpAddresses value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publicNetworkAccess()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publicNetworkAccess()"
name: "publicNetworkAccess()"
nameWithType: "ApiManagementServiceResource.publicNetworkAccess()"
summary: "Gets the public<wbr>Network<wbr>Access property: Whether or not public endpoint access is allowed for this API Management service."
modifiers:
- "abstract"
syntax: "public abstract PublicNetworkAccess publicNetworkAccess()"
desc: "Gets the publicNetworkAccess property: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'."
returns:
description: "the publicNetworkAccess value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.PublicNetworkAccess?alt=com.azure.resourcemanager.apimanagement.models.PublicNetworkAccess&text=PublicNetworkAccess\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publisherEmail()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publisherEmail()"
name: "publisherEmail()"
nameWithType: "ApiManagementServiceResource.publisherEmail()"
summary: "Gets the publisher<wbr>Email property: Publisher email."
modifiers:
- "abstract"
syntax: "public abstract String publisherEmail()"
desc: "Gets the publisherEmail property: Publisher email."
returns:
description: "the publisherEmail value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publisherName()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.publisherName()"
name: "publisherName()"
nameWithType: "ApiManagementServiceResource.publisherName()"
summary: "Gets the publisher<wbr>Name property: Publisher name."
modifiers:
- "abstract"
syntax: "public abstract String publisherName()"
desc: "Gets the publisherName property: Publisher name."
returns:
description: "the publisherName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.refresh()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.refresh()"
name: "refresh()"
nameWithType: "ApiManagementServiceResource.refresh()"
summary: "Refreshes the resource to sync with Azure."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceResource refresh()"
desc: "Refreshes the resource to sync with Azure."
returns:
description: "the refreshed resource."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.refresh(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.refresh(Context context)"
name: "refresh(Context context)"
nameWithType: "ApiManagementServiceResource.refresh(Context context)"
summary: "Refreshes the resource to sync with Azure."
modifiers:
- "abstract"
parameters:
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ApiManagementServiceResource refresh(Context context)"
desc: "Refreshes the resource to sync with Azure."
returns:
description: "the refreshed resource."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.region()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.region()"
name: "region()"
nameWithType: "ApiManagementServiceResource.region()"
summary: "Gets the region of the resource."
modifiers:
- "abstract"
syntax: "public abstract Region region()"
desc: "Gets the region of the resource."
returns:
description: "the region of the resource."
type: "<xref href=\"com.azure.core.management.Region?alt=com.azure.core.management.Region&text=Region\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.regionName()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.regionName()"
name: "regionName()"
nameWithType: "ApiManagementServiceResource.regionName()"
summary: "Gets the name of the resource region."
modifiers:
- "abstract"
syntax: "public abstract String regionName()"
desc: "Gets the name of the resource region."
returns:
description: "the name of the resource region."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.resourceGroupName()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.resourceGroupName()"
name: "resourceGroupName()"
nameWithType: "ApiManagementServiceResource.resourceGroupName()"
summary: "Gets the name of the resource group."
modifiers:
- "abstract"
syntax: "public abstract String resourceGroupName()"
desc: "Gets the name of the resource group."
returns:
description: "the name of the resource group."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.restore()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.restore()"
name: "restore()"
nameWithType: "ApiManagementServiceResource.restore()"
summary: "Gets the restore property: Undelete Api Management Service if it was previously soft-deleted."
modifiers:
- "abstract"
syntax: "public abstract Boolean restore()"
desc: "Gets the restore property: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored."
returns:
description: "the restore value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.scmUrl()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.scmUrl()"
name: "scmUrl()"
nameWithType: "ApiManagementServiceResource.scmUrl()"
summary: "Gets the scm<wbr>Url property: SCM endpoint URL of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract String scmUrl()"
desc: "Gets the scmUrl property: SCM endpoint URL of the API Management service."
returns:
description: "the scmUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.sku()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.sku()"
name: "sku()"
nameWithType: "ApiManagementServiceResource.sku()"
summary: "Gets the sku property: SKU properties of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceSkuProperties sku()"
desc: "Gets the sku property: SKU properties of the API Management service."
returns:
description: "the sku value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceSkuProperties?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceSkuProperties&text=ApiManagementServiceSkuProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.systemData()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.systemData()"
name: "systemData()"
nameWithType: "ApiManagementServiceResource.systemData()"
summary: "Gets the system<wbr>Data property: Metadata pertaining to creation and last modification of the resource."
modifiers:
- "abstract"
syntax: "public abstract SystemData systemData()"
desc: "Gets the systemData property: Metadata pertaining to creation and last modification of the resource."
returns:
description: "the systemData value."
type: "<xref href=\"com.azure.core.management.SystemData?alt=com.azure.core.management.SystemData&text=SystemData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.tags()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.tags()"
name: "tags()"
nameWithType: "ApiManagementServiceResource.tags()"
summary: "Gets the tags property: Resource tags."
modifiers:
- "abstract"
syntax: "public abstract Map<String,String> tags()"
desc: "Gets the tags property: Resource tags."
returns:
description: "the tags value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.targetProvisioningState()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.targetProvisioningState()"
name: "targetProvisioningState()"
nameWithType: "ApiManagementServiceResource.targetProvisioningState()"
summary: "Gets the target<wbr>Provisioning<wbr>State property: The provisioning state of the API Management service, which is targeted by the long running operation started on the service."
modifiers:
- "abstract"
syntax: "public abstract String targetProvisioningState()"
desc: "Gets the targetProvisioningState property: The provisioning state of the API Management service, which is targeted by the long running operation started on the service."
returns:
description: "the targetProvisioningState value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.type()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.type()"
name: "type()"
nameWithType: "ApiManagementServiceResource.type()"
summary: "Gets the type property: The type of the resource."
modifiers:
- "abstract"
syntax: "public abstract String type()"
desc: "Gets the type property: The type of the resource."
returns:
description: "the type value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.update()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.update()"
name: "update()"
nameWithType: "ApiManagementServiceResource.update()"
summary: "Begins update for the Api<wbr>Management<wbr>Service<wbr>Resource resource."
modifiers:
- "abstract"
syntax: "public abstract ApiManagementServiceResource.Update update()"
desc: "Begins update for the ApiManagementServiceResource resource."
returns:
description: "the stage of resource update."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.Update?alt=com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.virtualNetworkConfiguration()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.virtualNetworkConfiguration()"
name: "virtualNetworkConfiguration()"
nameWithType: "ApiManagementServiceResource.virtualNetworkConfiguration()"
summary: "Gets the virtual<wbr>Network<wbr>Configuration property: Virtual network configuration of the API Management service."
modifiers:
- "abstract"
syntax: "public abstract VirtualNetworkConfiguration virtualNetworkConfiguration()"
desc: "Gets the virtualNetworkConfiguration property: Virtual network configuration of the API Management service."
returns:
description: "the virtualNetworkConfiguration value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.VirtualNetworkConfiguration?alt=com.azure.resourcemanager.apimanagement.models.VirtualNetworkConfiguration&text=VirtualNetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.virtualNetworkType()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.virtualNetworkType()"
name: "virtualNetworkType()"
nameWithType: "ApiManagementServiceResource.virtualNetworkType()"
summary: "Gets the virtual<wbr>Network<wbr>Type property: The type of VPN in which API Management service needs to be configured in."
modifiers:
- "abstract"
syntax: "public abstract VirtualNetworkType virtualNetworkType()"
desc: "Gets the virtualNetworkType property: The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only."
returns:
description: "the virtualNetworkType value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.VirtualNetworkType?alt=com.azure.resourcemanager.apimanagement.models.VirtualNetworkType&text=VirtualNetworkType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.zones()"
fullName: "com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource.zones()"
name: "zones()"
nameWithType: "ApiManagementServiceResource.zones()"
summary: "Gets the zones property: A list of availability zones denoting where the resource needs to come from."
modifiers:
- "abstract"
syntax: "public abstract List<String> zones()"
desc: "Gets the zones property: A list of availability zones denoting where the resource needs to come from."
returns:
description: "the zones value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
type: "interface"
desc: "An immutable client-side representation of ApiManagementServiceResource."
metadata: {}
package: "com.azure.resourcemanager.apimanagement.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4