1package apimanagement 2 3// Copyright (c) Microsoft and contributors. All rights reserved. 4// 5// Licensed under the Apache License, Version 2.0 (the "License"); 6// you may not use this file except in compliance with the License. 7// You may obtain a copy of the License at 8// http://www.apache.org/licenses/LICENSE-2.0 9// 10// Unless required by applicable law or agreed to in writing, software 11// distributed under the License is distributed on an "AS IS" BASIS, 12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13// 14// See the License for the specific language governing permissions and 15// limitations under the License. 16// 17// Code generated by Microsoft (R) AutoRest Code Generator. 18// Changes may cause incorrect behavior and will be lost if the code is regenerated. 19 20// APIType enumerates the values for api type. 21type APIType string 22 23const ( 24 // HTTP ... 25 HTTP APIType = "http" 26 // Soap ... 27 Soap APIType = "soap" 28) 29 30// PossibleAPITypeValues returns an array of possible values for the APIType const type. 31func PossibleAPITypeValues() []APIType { 32 return []APIType{HTTP, Soap} 33} 34 35// AsyncOperationStatus enumerates the values for async operation status. 36type AsyncOperationStatus string 37 38const ( 39 // Failed ... 40 Failed AsyncOperationStatus = "Failed" 41 // InProgress ... 42 InProgress AsyncOperationStatus = "InProgress" 43 // Started ... 44 Started AsyncOperationStatus = "Started" 45 // Succeeded ... 46 Succeeded AsyncOperationStatus = "Succeeded" 47) 48 49// PossibleAsyncOperationStatusValues returns an array of possible values for the AsyncOperationStatus const type. 50func PossibleAsyncOperationStatusValues() []AsyncOperationStatus { 51 return []AsyncOperationStatus{Failed, InProgress, Started, Succeeded} 52} 53 54// AuthorizationMethod enumerates the values for authorization method. 55type AuthorizationMethod string 56 57const ( 58 // DELETE ... 59 DELETE AuthorizationMethod = "DELETE" 60 // GET ... 61 GET AuthorizationMethod = "GET" 62 // HEAD ... 63 HEAD AuthorizationMethod = "HEAD" 64 // OPTIONS ... 65 OPTIONS AuthorizationMethod = "OPTIONS" 66 // PATCH ... 67 PATCH AuthorizationMethod = "PATCH" 68 // POST ... 69 POST AuthorizationMethod = "POST" 70 // PUT ... 71 PUT AuthorizationMethod = "PUT" 72 // TRACE ... 73 TRACE AuthorizationMethod = "TRACE" 74) 75 76// PossibleAuthorizationMethodValues returns an array of possible values for the AuthorizationMethod const type. 77func PossibleAuthorizationMethodValues() []AuthorizationMethod { 78 return []AuthorizationMethod{DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE} 79} 80 81// BackendProtocol enumerates the values for backend protocol. 82type BackendProtocol string 83 84const ( 85 // BackendProtocolHTTP The Backend is a RESTful service. 86 BackendProtocolHTTP BackendProtocol = "http" 87 // BackendProtocolSoap The Backend is a SOAP service. 88 BackendProtocolSoap BackendProtocol = "soap" 89) 90 91// PossibleBackendProtocolValues returns an array of possible values for the BackendProtocol const type. 92func PossibleBackendProtocolValues() []BackendProtocol { 93 return []BackendProtocol{BackendProtocolHTTP, BackendProtocolSoap} 94} 95 96// BearerTokenSendingMethod enumerates the values for bearer token sending method. 97type BearerTokenSendingMethod string 98 99const ( 100 // AuthorizationHeader ... 101 AuthorizationHeader BearerTokenSendingMethod = "authorizationHeader" 102 // Query ... 103 Query BearerTokenSendingMethod = "query" 104) 105 106// PossibleBearerTokenSendingMethodValues returns an array of possible values for the BearerTokenSendingMethod const type. 107func PossibleBearerTokenSendingMethodValues() []BearerTokenSendingMethod { 108 return []BearerTokenSendingMethod{AuthorizationHeader, Query} 109} 110 111// ClientAuthenticationMethod enumerates the values for client authentication method. 112type ClientAuthenticationMethod string 113 114const ( 115 // Basic Basic Client Authentication method. 116 Basic ClientAuthenticationMethod = "Basic" 117 // Body Body based Authentication method. 118 Body ClientAuthenticationMethod = "Body" 119) 120 121// PossibleClientAuthenticationMethodValues returns an array of possible values for the ClientAuthenticationMethod const type. 122func PossibleClientAuthenticationMethodValues() []ClientAuthenticationMethod { 123 return []ClientAuthenticationMethod{Basic, Body} 124} 125 126// Confirmation enumerates the values for confirmation. 127type Confirmation string 128 129const ( 130 // Invite Send an e-mail inviting the user to sign-up and complete registration. 131 Invite Confirmation = "invite" 132 // Signup Send an e-mail to the user confirming they have successfully signed up. 133 Signup Confirmation = "signup" 134) 135 136// PossibleConfirmationValues returns an array of possible values for the Confirmation const type. 137func PossibleConfirmationValues() []Confirmation { 138 return []Confirmation{Invite, Signup} 139} 140 141// ConnectivityStatusType enumerates the values for connectivity status type. 142type ConnectivityStatusType string 143 144const ( 145 // Failure ... 146 Failure ConnectivityStatusType = "failure" 147 // Initializing ... 148 Initializing ConnectivityStatusType = "initializing" 149 // Success ... 150 Success ConnectivityStatusType = "success" 151) 152 153// PossibleConnectivityStatusTypeValues returns an array of possible values for the ConnectivityStatusType const type. 154func PossibleConnectivityStatusTypeValues() []ConnectivityStatusType { 155 return []ConnectivityStatusType{Failure, Initializing, Success} 156} 157 158// ContentFormat enumerates the values for content format. 159type ContentFormat string 160 161const ( 162 // SwaggerJSON The contents are inline and Content Type is a OpenApi 2.0 Document. 163 SwaggerJSON ContentFormat = "swagger-json" 164 // SwaggerLinkJSON The Open Api 2.0 document is hosted on a publicly accessible internet address. 165 SwaggerLinkJSON ContentFormat = "swagger-link-json" 166 // WadlLinkJSON The WADL document is hosted on a publicly accessible internet address. 167 WadlLinkJSON ContentFormat = "wadl-link-json" 168 // WadlXML The contents are inline and Content type is a WADL document. 169 WadlXML ContentFormat = "wadl-xml" 170 // Wsdl The contents are inline and the document is a WSDL/Soap document. 171 Wsdl ContentFormat = "wsdl" 172 // WsdlLink The WSDL document is hosted on a publicly accessible internet address. 173 WsdlLink ContentFormat = "wsdl-link" 174) 175 176// PossibleContentFormatValues returns an array of possible values for the ContentFormat const type. 177func PossibleContentFormatValues() []ContentFormat { 178 return []ContentFormat{SwaggerJSON, SwaggerLinkJSON, WadlLinkJSON, WadlXML, Wsdl, WsdlLink} 179} 180 181// GrantType enumerates the values for grant type. 182type GrantType string 183 184const ( 185 // AuthorizationCode Authorization Code Grant flow as described 186 // https://tools.ietf.org/html/rfc6749#section-4.1. 187 AuthorizationCode GrantType = "authorizationCode" 188 // ClientCredentials Client Credentials Grant flow as described 189 // https://tools.ietf.org/html/rfc6749#section-4.4. 190 ClientCredentials GrantType = "clientCredentials" 191 // Implicit Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2. 192 Implicit GrantType = "implicit" 193 // ResourceOwnerPassword Resource Owner Password Grant flow as described 194 // https://tools.ietf.org/html/rfc6749#section-4.3. 195 ResourceOwnerPassword GrantType = "resourceOwnerPassword" 196) 197 198// PossibleGrantTypeValues returns an array of possible values for the GrantType const type. 199func PossibleGrantTypeValues() []GrantType { 200 return []GrantType{AuthorizationCode, ClientCredentials, Implicit, ResourceOwnerPassword} 201} 202 203// GroupType enumerates the values for group type. 204type GroupType string 205 206const ( 207 // Custom ... 208 Custom GroupType = "custom" 209 // External ... 210 External GroupType = "external" 211 // System ... 212 System GroupType = "system" 213) 214 215// PossibleGroupTypeValues returns an array of possible values for the GroupType const type. 216func PossibleGroupTypeValues() []GroupType { 217 return []GroupType{Custom, External, System} 218} 219 220// HostnameType enumerates the values for hostname type. 221type HostnameType string 222 223const ( 224 // Management ... 225 Management HostnameType = "Management" 226 // Portal ... 227 Portal HostnameType = "Portal" 228 // Proxy ... 229 Proxy HostnameType = "Proxy" 230 // Scm ... 231 Scm HostnameType = "Scm" 232) 233 234// PossibleHostnameTypeValues returns an array of possible values for the HostnameType const type. 235func PossibleHostnameTypeValues() []HostnameType { 236 return []HostnameType{Management, Portal, Proxy, Scm} 237} 238 239// IdentityProviderType enumerates the values for identity provider type. 240type IdentityProviderType string 241 242const ( 243 // Aad Azure Active Directory as Identity provider. 244 Aad IdentityProviderType = "aad" 245 // AadB2C Azure Active Directory B2C as Identity provider. 246 AadB2C IdentityProviderType = "aadB2C" 247 // Facebook Facebook as Identity provider. 248 Facebook IdentityProviderType = "facebook" 249 // Google Google as Identity provider. 250 Google IdentityProviderType = "google" 251 // Microsoft Microsoft Live as Identity provider. 252 Microsoft IdentityProviderType = "microsoft" 253 // Twitter Twitter as Identity provider. 254 Twitter IdentityProviderType = "twitter" 255) 256 257// PossibleIdentityProviderTypeValues returns an array of possible values for the IdentityProviderType const type. 258func PossibleIdentityProviderTypeValues() []IdentityProviderType { 259 return []IdentityProviderType{Aad, AadB2C, Facebook, Google, Microsoft, Twitter} 260} 261 262// KeyType enumerates the values for key type. 263type KeyType string 264 265const ( 266 // Primary ... 267 Primary KeyType = "primary" 268 // Secondary ... 269 Secondary KeyType = "secondary" 270) 271 272// PossibleKeyTypeValues returns an array of possible values for the KeyType const type. 273func PossibleKeyTypeValues() []KeyType { 274 return []KeyType{Primary, Secondary} 275} 276 277// LoggerType enumerates the values for logger type. 278type LoggerType string 279 280const ( 281 // ApplicationInsights Azure Application Insights as log destination. 282 ApplicationInsights LoggerType = "applicationInsights" 283 // AzureEventHub Azure Event Hub as log destination. 284 AzureEventHub LoggerType = "azureEventHub" 285) 286 287// PossibleLoggerTypeValues returns an array of possible values for the LoggerType const type. 288func PossibleLoggerTypeValues() []LoggerType { 289 return []LoggerType{ApplicationInsights, AzureEventHub} 290} 291 292// NameAvailabilityReason enumerates the values for name availability reason. 293type NameAvailabilityReason string 294 295const ( 296 // AlreadyExists ... 297 AlreadyExists NameAvailabilityReason = "AlreadyExists" 298 // Invalid ... 299 Invalid NameAvailabilityReason = "Invalid" 300 // Valid ... 301 Valid NameAvailabilityReason = "Valid" 302) 303 304// PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type. 305func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason { 306 return []NameAvailabilityReason{AlreadyExists, Invalid, Valid} 307} 308 309// NotificationName enumerates the values for notification name. 310type NotificationName string 311 312const ( 313 // AccountClosedPublisher The following email recipients and users will receive email notifications when 314 // developer closes his account. 315 AccountClosedPublisher NotificationName = "AccountClosedPublisher" 316 // BCC The following recipients will receive blind carbon copies of all emails sent to developers. 317 BCC NotificationName = "BCC" 318 // NewApplicationNotificationMessage The following email recipients and users will receive email 319 // notifications when new applications are submitted to the application gallery. 320 NewApplicationNotificationMessage NotificationName = "NewApplicationNotificationMessage" 321 // NewIssuePublisherNotificationMessage The following email recipients and users will receive email 322 // notifications when a new issue or comment is submitted on the developer portal. 323 NewIssuePublisherNotificationMessage NotificationName = "NewIssuePublisherNotificationMessage" 324 // PurchasePublisherNotificationMessage The following email recipients and users will receive email 325 // notifications about new API product subscriptions. 326 PurchasePublisherNotificationMessage NotificationName = "PurchasePublisherNotificationMessage" 327 // QuotaLimitApproachingPublisherNotificationMessage The following email recipients and users will receive 328 // email notifications when subscription usage gets close to usage quota. 329 QuotaLimitApproachingPublisherNotificationMessage NotificationName = "QuotaLimitApproachingPublisherNotificationMessage" 330 // RequestPublisherNotificationMessage The following email recipients and users will receive email 331 // notifications about subscription requests for API products requiring approval. 332 RequestPublisherNotificationMessage NotificationName = "RequestPublisherNotificationMessage" 333) 334 335// PossibleNotificationNameValues returns an array of possible values for the NotificationName const type. 336func PossibleNotificationNameValues() []NotificationName { 337 return []NotificationName{AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, RequestPublisherNotificationMessage} 338} 339 340// PolicyScopeContract enumerates the values for policy scope contract. 341type PolicyScopeContract string 342 343const ( 344 // PolicyScopeContractAll ... 345 PolicyScopeContractAll PolicyScopeContract = "All" 346 // PolicyScopeContractAPI ... 347 PolicyScopeContractAPI PolicyScopeContract = "Api" 348 // PolicyScopeContractOperation ... 349 PolicyScopeContractOperation PolicyScopeContract = "Operation" 350 // PolicyScopeContractProduct ... 351 PolicyScopeContractProduct PolicyScopeContract = "Product" 352 // PolicyScopeContractTenant ... 353 PolicyScopeContractTenant PolicyScopeContract = "Tenant" 354) 355 356// PossiblePolicyScopeContractValues returns an array of possible values for the PolicyScopeContract const type. 357func PossiblePolicyScopeContractValues() []PolicyScopeContract { 358 return []PolicyScopeContract{PolicyScopeContractAll, PolicyScopeContractAPI, PolicyScopeContractOperation, PolicyScopeContractProduct, PolicyScopeContractTenant} 359} 360 361// ProductState enumerates the values for product state. 362type ProductState string 363 364const ( 365 // NotPublished ... 366 NotPublished ProductState = "notPublished" 367 // Published ... 368 Published ProductState = "published" 369) 370 371// PossibleProductStateValues returns an array of possible values for the ProductState const type. 372func PossibleProductStateValues() []ProductState { 373 return []ProductState{NotPublished, Published} 374} 375 376// Protocol enumerates the values for protocol. 377type Protocol string 378 379const ( 380 // ProtocolHTTP ... 381 ProtocolHTTP Protocol = "http" 382 // ProtocolHTTPS ... 383 ProtocolHTTPS Protocol = "https" 384) 385 386// PossibleProtocolValues returns an array of possible values for the Protocol const type. 387func PossibleProtocolValues() []Protocol { 388 return []Protocol{ProtocolHTTP, ProtocolHTTPS} 389} 390 391// SamplingType enumerates the values for sampling type. 392type SamplingType string 393 394const ( 395 // Adaptive Sampling with a dynamically adjustable rate. 396 Adaptive SamplingType = "adaptive" 397 // Fixed Fixed-rate sampling. 398 Fixed SamplingType = "fixed" 399) 400 401// PossibleSamplingTypeValues returns an array of possible values for the SamplingType const type. 402func PossibleSamplingTypeValues() []SamplingType { 403 return []SamplingType{Adaptive, Fixed} 404} 405 406// SkuType enumerates the values for sku type. 407type SkuType string 408 409const ( 410 // SkuTypeBasic Basic SKU of Api Management. 411 SkuTypeBasic SkuType = "Basic" 412 // SkuTypeDeveloper Developer SKU of Api Management. 413 SkuTypeDeveloper SkuType = "Developer" 414 // SkuTypePremium Premium SKU of Api Management. 415 SkuTypePremium SkuType = "Premium" 416 // SkuTypeStandard Standard SKU of Api Management. 417 SkuTypeStandard SkuType = "Standard" 418) 419 420// PossibleSkuTypeValues returns an array of possible values for the SkuType const type. 421func PossibleSkuTypeValues() []SkuType { 422 return []SkuType{SkuTypeBasic, SkuTypeDeveloper, SkuTypePremium, SkuTypeStandard} 423} 424 425// State enumerates the values for state. 426type State string 427 428const ( 429 // Closed The issue was closed. 430 Closed State = "closed" 431 // Open The issue is opened. 432 Open State = "open" 433 // Proposed The issue is proposed. 434 Proposed State = "proposed" 435 // Removed The issue was removed. 436 Removed State = "removed" 437 // Resolved The issue is now resolved. 438 Resolved State = "resolved" 439) 440 441// PossibleStateValues returns an array of possible values for the State const type. 442func PossibleStateValues() []State { 443 return []State{Closed, Open, Proposed, Removed, Resolved} 444} 445 446// StoreName enumerates the values for store name. 447type StoreName string 448 449const ( 450 // CertificateAuthority ... 451 CertificateAuthority StoreName = "CertificateAuthority" 452 // Root ... 453 Root StoreName = "Root" 454) 455 456// PossibleStoreNameValues returns an array of possible values for the StoreName const type. 457func PossibleStoreNameValues() []StoreName { 458 return []StoreName{CertificateAuthority, Root} 459} 460 461// SubscriptionState enumerates the values for subscription state. 462type SubscriptionState string 463 464const ( 465 // Active ... 466 Active SubscriptionState = "active" 467 // Cancelled ... 468 Cancelled SubscriptionState = "cancelled" 469 // Expired ... 470 Expired SubscriptionState = "expired" 471 // Rejected ... 472 Rejected SubscriptionState = "rejected" 473 // Submitted ... 474 Submitted SubscriptionState = "submitted" 475 // Suspended ... 476 Suspended SubscriptionState = "suspended" 477) 478 479// PossibleSubscriptionStateValues returns an array of possible values for the SubscriptionState const type. 480func PossibleSubscriptionStateValues() []SubscriptionState { 481 return []SubscriptionState{Active, Cancelled, Expired, Rejected, Submitted, Suspended} 482} 483 484// TemplateName enumerates the values for template name. 485type TemplateName string 486 487const ( 488 // AccountClosedDeveloper ... 489 AccountClosedDeveloper TemplateName = "accountClosedDeveloper" 490 // ApplicationApprovedNotificationMessage ... 491 ApplicationApprovedNotificationMessage TemplateName = "applicationApprovedNotificationMessage" 492 // ConfirmSignUpIdentityDefault ... 493 ConfirmSignUpIdentityDefault TemplateName = "confirmSignUpIdentityDefault" 494 // EmailChangeIdentityDefault ... 495 EmailChangeIdentityDefault TemplateName = "emailChangeIdentityDefault" 496 // InviteUserNotificationMessage ... 497 InviteUserNotificationMessage TemplateName = "inviteUserNotificationMessage" 498 // NewCommentNotificationMessage ... 499 NewCommentNotificationMessage TemplateName = "newCommentNotificationMessage" 500 // NewDeveloperNotificationMessage ... 501 NewDeveloperNotificationMessage TemplateName = "newDeveloperNotificationMessage" 502 // NewIssueNotificationMessage ... 503 NewIssueNotificationMessage TemplateName = "newIssueNotificationMessage" 504 // PasswordResetByAdminNotificationMessage ... 505 PasswordResetByAdminNotificationMessage TemplateName = "passwordResetByAdminNotificationMessage" 506 // PasswordResetIdentityDefault ... 507 PasswordResetIdentityDefault TemplateName = "passwordResetIdentityDefault" 508 // PurchaseDeveloperNotificationMessage ... 509 PurchaseDeveloperNotificationMessage TemplateName = "purchaseDeveloperNotificationMessage" 510 // QuotaLimitApproachingDeveloperNotificationMessage ... 511 QuotaLimitApproachingDeveloperNotificationMessage TemplateName = "quotaLimitApproachingDeveloperNotificationMessage" 512 // RejectDeveloperNotificationMessage ... 513 RejectDeveloperNotificationMessage TemplateName = "rejectDeveloperNotificationMessage" 514 // RequestDeveloperNotificationMessage ... 515 RequestDeveloperNotificationMessage TemplateName = "requestDeveloperNotificationMessage" 516) 517 518// PossibleTemplateNameValues returns an array of possible values for the TemplateName const type. 519func PossibleTemplateNameValues() []TemplateName { 520 return []TemplateName{AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage} 521} 522 523// UserState enumerates the values for user state. 524type UserState string 525 526const ( 527 // UserStateActive User state is active. 528 UserStateActive UserState = "active" 529 // UserStateBlocked User is blocked. Blocked users cannot authenticate at developer portal or call API. 530 UserStateBlocked UserState = "blocked" 531 // UserStateDeleted User account is closed. All identities and related entities are removed. 532 UserStateDeleted UserState = "deleted" 533 // UserStatePending User account is pending. Requires identity confirmation before it can be made active. 534 UserStatePending UserState = "pending" 535) 536 537// PossibleUserStateValues returns an array of possible values for the UserState const type. 538func PossibleUserStateValues() []UserState { 539 return []UserState{UserStateActive, UserStateBlocked, UserStateDeleted, UserStatePending} 540} 541 542// VersioningScheme enumerates the values for versioning scheme. 543type VersioningScheme string 544 545const ( 546 // VersioningSchemeHeader The API Version is passed in a HTTP header. 547 VersioningSchemeHeader VersioningScheme = "Header" 548 // VersioningSchemeQuery The API Version is passed in a query parameter. 549 VersioningSchemeQuery VersioningScheme = "Query" 550 // VersioningSchemeSegment The API Version is passed in a path segment. 551 VersioningSchemeSegment VersioningScheme = "Segment" 552) 553 554// PossibleVersioningSchemeValues returns an array of possible values for the VersioningScheme const type. 555func PossibleVersioningSchemeValues() []VersioningScheme { 556 return []VersioningScheme{VersioningSchemeHeader, VersioningSchemeQuery, VersioningSchemeSegment} 557} 558 559// VirtualNetworkType enumerates the values for virtual network type. 560type VirtualNetworkType string 561 562const ( 563 // VirtualNetworkTypeExternal The service is part of Virtual Network and it is accessible from Internet. 564 VirtualNetworkTypeExternal VirtualNetworkType = "External" 565 // VirtualNetworkTypeInternal The service is part of Virtual Network and it is only accessible from within 566 // the virtual network. 567 VirtualNetworkTypeInternal VirtualNetworkType = "Internal" 568 // VirtualNetworkTypeNone The service is not part of any Virtual Network. 569 VirtualNetworkTypeNone VirtualNetworkType = "None" 570) 571 572// PossibleVirtualNetworkTypeValues returns an array of possible values for the VirtualNetworkType const type. 573func PossibleVirtualNetworkTypeValues() []VirtualNetworkType { 574 return []VirtualNetworkType{VirtualNetworkTypeExternal, VirtualNetworkTypeInternal, VirtualNetworkTypeNone} 575} 576