-
Notifications
You must be signed in to change notification settings - Fork 819
/
models.go
3984 lines (3580 loc) · 161 KB
/
models.go
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
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package apimanagement
// Copyright (c) Microsoft and contributors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
import (
"context"
"encoding/json"
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/azure"
"github.com/Azure/go-autorest/autorest/date"
"github.com/Azure/go-autorest/autorest/to"
"github.com/Azure/go-autorest/tracing"
"net/http"
)
// The package's fully qualified name.
const fqdn = "github.com/Azure/azure-sdk-for-go/services/apimanagement/mgmt/2016-07-07/apimanagement"
// APIProtocolContract enumerates the values for api protocol contract.
type APIProtocolContract string
const (
// HTTP ...
HTTP APIProtocolContract = "Http"
// HTTPS ...
HTTPS APIProtocolContract = "Https"
)
// PossibleAPIProtocolContractValues returns an array of possible values for the APIProtocolContract const type.
func PossibleAPIProtocolContractValues() []APIProtocolContract {
return []APIProtocolContract{HTTP, HTTPS}
}
// APITypeContract enumerates the values for api type contract.
type APITypeContract string
const (
// APITypeContractHTTP ...
APITypeContractHTTP APITypeContract = "Http"
// APITypeContractSoap ...
APITypeContractSoap APITypeContract = "Soap"
)
// PossibleAPITypeContractValues returns an array of possible values for the APITypeContract const type.
func PossibleAPITypeContractValues() []APITypeContract {
return []APITypeContract{APITypeContractHTTP, APITypeContractSoap}
}
// AsyncOperationState enumerates the values for async operation state.
type AsyncOperationState string
const (
// Failed ...
Failed AsyncOperationState = "Failed"
// InProgress ...
InProgress AsyncOperationState = "InProgress"
// Started ...
Started AsyncOperationState = "Started"
// Succeeded ...
Succeeded AsyncOperationState = "Succeeded"
)
// PossibleAsyncOperationStateValues returns an array of possible values for the AsyncOperationState const type.
func PossibleAsyncOperationStateValues() []AsyncOperationState {
return []AsyncOperationState{Failed, InProgress, Started, Succeeded}
}
// BearerTokenSendingMethodsContract enumerates the values for bearer token sending methods contract.
type BearerTokenSendingMethodsContract string
const (
// AuthorizationHeader ...
AuthorizationHeader BearerTokenSendingMethodsContract = "authorizationHeader"
// Query ...
Query BearerTokenSendingMethodsContract = "query"
)
// PossibleBearerTokenSendingMethodsContractValues returns an array of possible values for the BearerTokenSendingMethodsContract const type.
func PossibleBearerTokenSendingMethodsContractValues() []BearerTokenSendingMethodsContract {
return []BearerTokenSendingMethodsContract{AuthorizationHeader, Query}
}
// ClientAuthenticationMethodContract enumerates the values for client authentication method contract.
type ClientAuthenticationMethodContract string
const (
// Basic ...
Basic ClientAuthenticationMethodContract = "Basic"
// Body ...
Body ClientAuthenticationMethodContract = "Body"
)
// PossibleClientAuthenticationMethodContractValues returns an array of possible values for the ClientAuthenticationMethodContract const type.
func PossibleClientAuthenticationMethodContractValues() []ClientAuthenticationMethodContract {
return []ClientAuthenticationMethodContract{Basic, Body}
}
// GrantTypesContract enumerates the values for grant types contract.
type GrantTypesContract string
const (
// AuthorizationCode ...
AuthorizationCode GrantTypesContract = "authorizationCode"
// ClientCredentials ...
ClientCredentials GrantTypesContract = "clientCredentials"
// Implicit ...
Implicit GrantTypesContract = "implicit"
// ResourceOwnerPassword ...
ResourceOwnerPassword GrantTypesContract = "resourceOwnerPassword"
)
// PossibleGrantTypesContractValues returns an array of possible values for the GrantTypesContract const type.
func PossibleGrantTypesContractValues() []GrantTypesContract {
return []GrantTypesContract{AuthorizationCode, ClientCredentials, Implicit, ResourceOwnerPassword}
}
// GroupTypeContract enumerates the values for group type contract.
type GroupTypeContract string
const (
// Custom ...
Custom GroupTypeContract = "Custom"
// External ...
External GroupTypeContract = "External"
// System ...
System GroupTypeContract = "System"
)
// PossibleGroupTypeContractValues returns an array of possible values for the GroupTypeContract const type.
func PossibleGroupTypeContractValues() []GroupTypeContract {
return []GroupTypeContract{Custom, External, System}
}
// HostnameType enumerates the values for hostname type.
type HostnameType string
const (
// Management ...
Management HostnameType = "Management"
// Portal ...
Portal HostnameType = "Portal"
// Proxy ...
Proxy HostnameType = "Proxy"
// Scm ...
Scm HostnameType = "Scm"
)
// PossibleHostnameTypeValues returns an array of possible values for the HostnameType const type.
func PossibleHostnameTypeValues() []HostnameType {
return []HostnameType{Management, Portal, Proxy, Scm}
}
// HTTPStatusCode enumerates the values for http status code.
type HTTPStatusCode string
const (
// Accepted ...
Accepted HTTPStatusCode = "Accepted"
// Conflict ...
Conflict HTTPStatusCode = "Conflict"
// Continue ...
Continue HTTPStatusCode = "Continue"
// Created ...
Created HTTPStatusCode = "Created"
// NotFound ...
NotFound HTTPStatusCode = "NotFound"
// OK ...
OK HTTPStatusCode = "OK"
)
// PossibleHTTPStatusCodeValues returns an array of possible values for the HTTPStatusCode const type.
func PossibleHTTPStatusCodeValues() []HTTPStatusCode {
return []HTTPStatusCode{Accepted, Conflict, Continue, Created, NotFound, OK}
}
// IdentityProviderNameType enumerates the values for identity provider name type.
type IdentityProviderNameType string
const (
// Aad ...
Aad IdentityProviderNameType = "aad"
// Facebook ...
Facebook IdentityProviderNameType = "facebook"
// Google ...
Google IdentityProviderNameType = "google"
// Microsoft ...
Microsoft IdentityProviderNameType = "microsoft"
// Twitter ...
Twitter IdentityProviderNameType = "twitter"
)
// PossibleIdentityProviderNameTypeValues returns an array of possible values for the IdentityProviderNameType const type.
func PossibleIdentityProviderNameTypeValues() []IdentityProviderNameType {
return []IdentityProviderNameType{Aad, Facebook, Google, Microsoft, Twitter}
}
// MethodContract enumerates the values for method contract.
type MethodContract string
const (
// DELETE ...
DELETE MethodContract = "DELETE"
// GET ...
GET MethodContract = "GET"
// HEAD ...
HEAD MethodContract = "HEAD"
// OPTIONS ...
OPTIONS MethodContract = "OPTIONS"
// PATCH ...
PATCH MethodContract = "PATCH"
// POST ...
POST MethodContract = "POST"
// PUT ...
PUT MethodContract = "PUT"
// TRACE ...
TRACE MethodContract = "TRACE"
)
// PossibleMethodContractValues returns an array of possible values for the MethodContract const type.
func PossibleMethodContractValues() []MethodContract {
return []MethodContract{DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE}
}
// NameAvailabilityReason enumerates the values for name availability reason.
type NameAvailabilityReason string
const (
// AlreadyExists ...
AlreadyExists NameAvailabilityReason = "AlreadyExists"
// Invalid ...
Invalid NameAvailabilityReason = "Invalid"
// Valid ...
Valid NameAvailabilityReason = "Valid"
)
// PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.
func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason {
return []NameAvailabilityReason{AlreadyExists, Invalid, Valid}
}
// OperationStatus enumerates the values for operation status.
type OperationStatus string
const (
// OperationStatusFailed ...
OperationStatusFailed OperationStatus = "Failed"
// OperationStatusInProgress ...
OperationStatusInProgress OperationStatus = "InProgress"
// OperationStatusSucceeded ...
OperationStatusSucceeded OperationStatus = "Succeeded"
)
// PossibleOperationStatusValues returns an array of possible values for the OperationStatus const type.
func PossibleOperationStatusValues() []OperationStatus {
return []OperationStatus{OperationStatusFailed, OperationStatusInProgress, OperationStatusSucceeded}
}
// PolicyScopeContract enumerates the values for policy scope contract.
type PolicyScopeContract string
const (
// All ...
All PolicyScopeContract = "All"
// API ...
API PolicyScopeContract = "Api"
// Operation ...
Operation PolicyScopeContract = "Operation"
// Product ...
Product PolicyScopeContract = "Product"
// Tenant ...
Tenant PolicyScopeContract = "Tenant"
)
// PossiblePolicyScopeContractValues returns an array of possible values for the PolicyScopeContract const type.
func PossiblePolicyScopeContractValues() []PolicyScopeContract {
return []PolicyScopeContract{All, API, Operation, Product, Tenant}
}
// ProductStateContract enumerates the values for product state contract.
type ProductStateContract string
const (
// NotPublished ...
NotPublished ProductStateContract = "NotPublished"
// Published ...
Published ProductStateContract = "Published"
)
// PossibleProductStateContractValues returns an array of possible values for the ProductStateContract const type.
func PossibleProductStateContractValues() []ProductStateContract {
return []ProductStateContract{NotPublished, Published}
}
// ReportsAggregation enumerates the values for reports aggregation.
type ReportsAggregation string
const (
// ByAPI ...
ByAPI ReportsAggregation = "byApi"
// ByGeo ...
ByGeo ReportsAggregation = "byGeo"
// ByOperation ...
ByOperation ReportsAggregation = "byOperation"
// ByProduct ...
ByProduct ReportsAggregation = "byProduct"
// BySubscription ...
BySubscription ReportsAggregation = "bySubscription"
// ByTime ...
ByTime ReportsAggregation = "byTime"
// ByUser ...
ByUser ReportsAggregation = "byUser"
)
// PossibleReportsAggregationValues returns an array of possible values for the ReportsAggregation const type.
func PossibleReportsAggregationValues() []ReportsAggregation {
return []ReportsAggregation{ByAPI, ByGeo, ByOperation, ByProduct, BySubscription, ByTime, ByUser}
}
// SkuType enumerates the values for sku type.
type SkuType string
const (
// Developer ...
Developer SkuType = "Developer"
// Premium ...
Premium SkuType = "Premium"
// Standard ...
Standard SkuType = "Standard"
)
// PossibleSkuTypeValues returns an array of possible values for the SkuType const type.
func PossibleSkuTypeValues() []SkuType {
return []SkuType{Developer, Premium, Standard}
}
// SubscriptionStateContract enumerates the values for subscription state contract.
type SubscriptionStateContract string
const (
// Active ...
Active SubscriptionStateContract = "Active"
// Cancelled ...
Cancelled SubscriptionStateContract = "Cancelled"
// Expired ...
Expired SubscriptionStateContract = "Expired"
// Rejected ...
Rejected SubscriptionStateContract = "Rejected"
// Submitted ...
Submitted SubscriptionStateContract = "Submitted"
// Suspended ...
Suspended SubscriptionStateContract = "Suspended"
)
// PossibleSubscriptionStateContractValues returns an array of possible values for the SubscriptionStateContract const type.
func PossibleSubscriptionStateContractValues() []SubscriptionStateContract {
return []SubscriptionStateContract{Active, Cancelled, Expired, Rejected, Submitted, Suspended}
}
// UserStateContract enumerates the values for user state contract.
type UserStateContract string
const (
// UserStateContractActive ...
UserStateContractActive UserStateContract = "Active"
// UserStateContractBlocked ...
UserStateContractBlocked UserStateContract = "Blocked"
)
// PossibleUserStateContractValues returns an array of possible values for the UserStateContract const type.
func PossibleUserStateContractValues() []UserStateContract {
return []UserStateContract{UserStateContractActive, UserStateContractBlocked}
}
// VirtualNetworkType enumerates the values for virtual network type.
type VirtualNetworkType string
const (
// VirtualNetworkTypeExternal ...
VirtualNetworkTypeExternal VirtualNetworkType = "External"
// VirtualNetworkTypeInternal ...
VirtualNetworkTypeInternal VirtualNetworkType = "Internal"
// VirtualNetworkTypeNone ...
VirtualNetworkTypeNone VirtualNetworkType = "None"
)
// PossibleVirtualNetworkTypeValues returns an array of possible values for the VirtualNetworkType const type.
func PossibleVirtualNetworkTypeValues() []VirtualNetworkType {
return []VirtualNetworkType{VirtualNetworkTypeExternal, VirtualNetworkTypeInternal, VirtualNetworkTypeNone}
}
// AccessInformationContract tenant access information contract of the API Management service.
type AccessInformationContract struct {
autorest.Response `json:"-"`
// ID - Identifier.
ID *string `json:"id,omitempty"`
// PrimaryKey - Primary access key.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - Secondary access key.
SecondaryKey *string `json:"secondaryKey,omitempty"`
// Enabled - Tenant access information of the API Management service.
Enabled *bool `json:"enabled,omitempty"`
}
// AccessInformationUpdateParameters tenant access information update parameters of the API Management
// service.
type AccessInformationUpdateParameters struct {
// Enabled - Tenant access information of the API Management service.
Enabled *bool `json:"enabled,omitempty"`
}
// AdditionalRegion description of an additional API Management resource location.
type AdditionalRegion struct {
// Location - The location name of the additional region among Azure Data center regions.
Location *string `json:"location,omitempty"`
// SkuType - The SKU type in the location. Possible values include: 'Developer', 'Standard', 'Premium'
SkuType SkuType `json:"skuType,omitempty"`
// SkuUnitCount - The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location.
SkuUnitCount *int32 `json:"skuUnitCount,omitempty"`
// StaticIPs - Static IP addresses of the location's virtual machines.
StaticIPs *[]string `json:"staticIPs,omitempty"`
// Vpnconfiguration - Virtual network configuration for the location.
Vpnconfiguration *VirtualNetworkConfiguration `json:"vpnconfiguration,omitempty"`
}
// APICollection paged Api list representation.
type APICollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]APIContract `json:"value,omitempty"`
// Count - Total records count number.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
// APICollectionIterator provides access to a complete listing of APIContract values.
type APICollectionIterator struct {
i int
page APICollectionPage
}
// NextWithContext advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *APICollectionIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/APICollectionIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (iter *APICollectionIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter APICollectionIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter APICollectionIterator) Response() APICollection {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter APICollectionIterator) Value() APIContract {
if !iter.page.NotDone() {
return APIContract{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the APICollectionIterator type.
func NewAPICollectionIterator(page APICollectionPage) APICollectionIterator {
return APICollectionIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (ac APICollection) IsEmpty() bool {
return ac.Value == nil || len(*ac.Value) == 0
}
// aPICollectionPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (ac APICollection) aPICollectionPreparer(ctx context.Context) (*http.Request, error) {
if ac.NextLink == nil || len(to.String(ac.NextLink)) < 1 {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(ac.NextLink)))
}
// APICollectionPage contains a page of APIContract values.
type APICollectionPage struct {
fn func(context.Context, APICollection) (APICollection, error)
ac APICollection
}
// NextWithContext advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
func (page *APICollectionPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/APICollectionPage.NextWithContext")
defer func() {
sc := -1
if page.Response().Response.Response != nil {
sc = page.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
next, err := page.fn(ctx, page.ac)
if err != nil {
return err
}
page.ac = next
return nil
}
// Next advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (page *APICollectionPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page APICollectionPage) NotDone() bool {
return !page.ac.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page APICollectionPage) Response() APICollection {
return page.ac
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page APICollectionPage) Values() []APIContract {
if page.ac.IsEmpty() {
return nil
}
return *page.ac.Value
}
// Creates a new instance of the APICollectionPage type.
func NewAPICollectionPage(getNextPage func(context.Context, APICollection) (APICollection, error)) APICollectionPage {
return APICollectionPage{fn: getNextPage}
}
// APIContract API details.
type APIContract struct {
autorest.Response `json:"-"`
// ID - API identifier path: /apis/{apiId}
ID *string `json:"id,omitempty"`
// Name - API name.
Name *string `json:"name,omitempty"`
// Description - Description of the API. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// ServiceURL - Absolute URL of the backend service implementing this API.
ServiceURL *string `json:"serviceUrl,omitempty"`
// Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
Path *string `json:"path,omitempty"`
// Protocols - Describes on which protocols the operations in this API can be invoked.
Protocols *[]APIProtocolContract `json:"protocols,omitempty"`
// AuthenticationSettings - Collection of authentication settings included into this API.
AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
// SubscriptionKeyParameterNames - Protocols over which API is made available.
SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
// Type - Type of API. Possible values include: 'APITypeContractHTTP', 'APITypeContractSoap'
Type APITypeContract `json:"type,omitempty"`
}
// APIExportResult the response model for the export API output operation.
type APIExportResult struct {
autorest.Response `json:"-"`
// Content - Response content bytes.
Content *[]byte `json:"content,omitempty"`
// StatusCode - Possible values include: 'Continue', 'OK', 'Created', 'Accepted', 'NotFound', 'Conflict'
StatusCode HTTPStatusCode `json:"statusCode,omitempty"`
RequestID *string `json:"requestId,omitempty"`
}
// AuthenticationSettingsContract API Authentication Settings.
type AuthenticationSettingsContract struct {
OAuth2 *OAuth2AuthenticationSettingsContract `json:"oAuth2,omitempty"`
}
// AuthorizationServerCollection paged OAuth2 Authorization Servers list representation.
type AuthorizationServerCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]OAuth2AuthorizationServerContract `json:"value,omitempty"`
// Count - Total records count number.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
// AuthorizationServerCollectionIterator provides access to a complete listing of
// OAuth2AuthorizationServerContract values.
type AuthorizationServerCollectionIterator struct {
i int
page AuthorizationServerCollectionPage
}
// NextWithContext advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *AuthorizationServerCollectionIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/AuthorizationServerCollectionIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (iter *AuthorizationServerCollectionIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AuthorizationServerCollectionIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter AuthorizationServerCollectionIterator) Response() AuthorizationServerCollection {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter AuthorizationServerCollectionIterator) Value() OAuth2AuthorizationServerContract {
if !iter.page.NotDone() {
return OAuth2AuthorizationServerContract{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the AuthorizationServerCollectionIterator type.
func NewAuthorizationServerCollectionIterator(page AuthorizationServerCollectionPage) AuthorizationServerCollectionIterator {
return AuthorizationServerCollectionIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (asc AuthorizationServerCollection) IsEmpty() bool {
return asc.Value == nil || len(*asc.Value) == 0
}
// authorizationServerCollectionPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (asc AuthorizationServerCollection) authorizationServerCollectionPreparer(ctx context.Context) (*http.Request, error) {
if asc.NextLink == nil || len(to.String(asc.NextLink)) < 1 {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(asc.NextLink)))
}
// AuthorizationServerCollectionPage contains a page of OAuth2AuthorizationServerContract values.
type AuthorizationServerCollectionPage struct {
fn func(context.Context, AuthorizationServerCollection) (AuthorizationServerCollection, error)
asc AuthorizationServerCollection
}
// NextWithContext advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
func (page *AuthorizationServerCollectionPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/AuthorizationServerCollectionPage.NextWithContext")
defer func() {
sc := -1
if page.Response().Response.Response != nil {
sc = page.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
next, err := page.fn(ctx, page.asc)
if err != nil {
return err
}
page.asc = next
return nil
}
// Next advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (page *AuthorizationServerCollectionPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AuthorizationServerCollectionPage) NotDone() bool {
return !page.asc.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page AuthorizationServerCollectionPage) Response() AuthorizationServerCollection {
return page.asc
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page AuthorizationServerCollectionPage) Values() []OAuth2AuthorizationServerContract {
if page.asc.IsEmpty() {
return nil
}
return *page.asc.Value
}
// Creates a new instance of the AuthorizationServerCollectionPage type.
func NewAuthorizationServerCollectionPage(getNextPage func(context.Context, AuthorizationServerCollection) (AuthorizationServerCollection, error)) AuthorizationServerCollectionPage {
return AuthorizationServerCollectionPage{fn: getNextPage}
}
// BackendCollection paged Backend list representation.
type BackendCollection struct {
autorest.Response `json:"-"`
// Value - Backend values.
Value *[]BackendResponse `json:"value,omitempty"`
// Count - Total records count number.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
// BackendCollectionIterator provides access to a complete listing of BackendResponse values.
type BackendCollectionIterator struct {
i int
page BackendCollectionPage
}
// NextWithContext advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *BackendCollectionIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/BackendCollectionIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (iter *BackendCollectionIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter BackendCollectionIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter BackendCollectionIterator) Response() BackendCollection {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter BackendCollectionIterator) Value() BackendResponse {
if !iter.page.NotDone() {
return BackendResponse{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the BackendCollectionIterator type.
func NewBackendCollectionIterator(page BackendCollectionPage) BackendCollectionIterator {
return BackendCollectionIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (bc BackendCollection) IsEmpty() bool {
return bc.Value == nil || len(*bc.Value) == 0
}
// backendCollectionPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (bc BackendCollection) backendCollectionPreparer(ctx context.Context) (*http.Request, error) {
if bc.NextLink == nil || len(to.String(bc.NextLink)) < 1 {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(bc.NextLink)))
}
// BackendCollectionPage contains a page of BackendResponse values.
type BackendCollectionPage struct {
fn func(context.Context, BackendCollection) (BackendCollection, error)
bc BackendCollection
}
// NextWithContext advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
func (page *BackendCollectionPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/BackendCollectionPage.NextWithContext")
defer func() {
sc := -1
if page.Response().Response.Response != nil {
sc = page.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
next, err := page.fn(ctx, page.bc)
if err != nil {
return err
}
page.bc = next
return nil
}
// Next advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (page *BackendCollectionPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page BackendCollectionPage) NotDone() bool {
return !page.bc.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page BackendCollectionPage) Response() BackendCollection {
return page.bc
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page BackendCollectionPage) Values() []BackendResponse {
if page.bc.IsEmpty() {
return nil
}
return *page.bc.Value
}
// Creates a new instance of the BackendCollectionPage type.
func NewBackendCollectionPage(getNextPage func(context.Context, BackendCollection) (BackendCollection, error)) BackendCollectionPage {
return BackendCollectionPage{fn: getNextPage}
}
// BackendContract parameters supplied to the Create Backend operation.
type BackendContract struct {
// Host - Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.
Host *string `json:"host,omitempty"`
// SkipCertificateChainValidation - Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.
SkipCertificateChainValidation *bool `json:"skipCertificateChainValidation,omitempty"`
}
// BackendResponse the Backend entity in API Management represents a backend service that is configured to
// skip certification chain validation when using a self-signed certificate to test mutual certificate
// authentication.
type BackendResponse struct {
autorest.Response `json:"-"`
// ID - Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier.
ID *string `json:"id,omitempty"`
// Host - Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.
Host *string `json:"host,omitempty"`
// SkipCertificateChainValidation - Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.
SkipCertificateChainValidation *bool `json:"skipCertificateChainValidation,omitempty"`
}
// BackendUpdateParameters parameters supplied to the Update Backend operation.
type BackendUpdateParameters struct {
// Host - Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.
Host *string `json:"host,omitempty"`
// SkipCertificateChainValidation - Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.
SkipCertificateChainValidation *bool `json:"skipCertificateChainValidation,omitempty"`
}
// CertificateCollection paged Certificates list representation.
type CertificateCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]CertificateContract `json:"value,omitempty"`
// Count - Total records count number.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
// CertificateCollectionIterator provides access to a complete listing of CertificateContract values.
type CertificateCollectionIterator struct {
i int
page CertificateCollectionPage
}
// NextWithContext advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *CertificateCollectionIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/CertificateCollectionIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (iter *CertificateCollectionIterator) Next() error {
return iter.NextWithContext(context.Background())
}