pulumi-azure-native 2.59.0a1725033095__py3-none-any.whl → 2.60.0__py3-none-any.whl

pulumi_azure_native/apimanagement/v20240501/_enums.py

@@ -0,0 +1,836 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+from enum import Enum
+
+__all__ = [
+    'AlwaysLog',
+    'ApiGatewaySkuType',
+    'ApiType',
+    'ApimIdentityType',
+    'AppType',
+    'AuthorizationMethod',
+    'AuthorizationType',
+    'BackendProtocol',
+    'BackendType',
+    'BearerTokenSendingMethod',
+    'BearerTokenSendingMethods',
+    'CertificateSource',
+    'CertificateStatus',
+    'ClientAuthenticationMethod',
+    'Confirmation',
+    'ContentFormat',
+    'DataMaskingMode',
+    'DeveloperPortalStatus',
+    'GatewayListDebugCredentialsContractPurpose',
+    'GrantType',
+    'GroupType',
+    'HostnameType',
+    'HttpCorrelationProtocol',
+    'IdentityProviderType',
+    'KeyType',
+    'LegacyApiState',
+    'LegacyPortalStatus',
+    'LoggerType',
+    'NatGatewayState',
+    'OAuth2GrantType',
+    'OperationNameFormat',
+    'PolicyContentFormat',
+    'PolicyFragmentContentFormat',
+    'PolicyRestrictionRequireBase',
+    'PrivateEndpointServiceConnectionStatus',
+    'ProductState',
+    'Protocol',
+    'ProvisioningState',
+    'PublicNetworkAccess',
+    'SamplingType',
+    'SchemaType',
+    'SkuType',
+    'SoapApiType',
+    'State',
+    'SubscriptionState',
+    'TranslateRequiredQueryParametersConduct',
+    'UserState',
+    'Verbosity',
+    'VersioningScheme',
+    'VirtualNetworkType',
+]
+
+
+class AlwaysLog(str, Enum):
+    """
+    Specifies for what type of messages sampling settings should not apply.
+    """
+    ALL_ERRORS = "allErrors"
+    """
+    Always log all erroneous request regardless of sampling settings.
+    """
+
+
+class ApiGatewaySkuType(str, Enum):
+    """
+    Name of the Sku.
+    """
+    STANDARD = "Standard"
+    """
+    Standard SKU of the API gateway.
+    """
+    WORKSPACE_GATEWAY_STANDARD = "WorkspaceGatewayStandard"
+    """
+    Standard SKU of the API gateway to be used in Workspaces.
+    """
+    WORKSPACE_GATEWAY_PREMIUM = "WorkspaceGatewayPremium"
+    """
+    Premium SKU of the API gateway to be used in Workspaces.
+    """
+
+
+class ApiType(str, Enum):
+    """
+    Type of API.
+    """
+    HTTP = "http"
+    SOAP = "soap"
+    WEBSOCKET = "websocket"
+    GRAPHQL = "graphql"
+    ODATA = "odata"
+    GRPC = "grpc"
+
+
+class ApimIdentityType(str, Enum):
+    """
+    The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
+    """
+    SYSTEM_ASSIGNED = "SystemAssigned"
+    USER_ASSIGNED = "UserAssigned"
+    SYSTEM_ASSIGNED_USER_ASSIGNED = "SystemAssigned, UserAssigned"
+    NONE = "None"
+
+
+class AppType(str, Enum):
+    """
+    Determines the type of application which send the create user request. Default is legacy portal.
+    """
+    PORTAL = "portal"
+    """
+    User create request was sent by legacy developer portal.
+    """
+    DEVELOPER_PORTAL = "developerPortal"
+    """
+    User create request was sent by new developer portal.
+    """
+
+
+class AuthorizationMethod(str, Enum):
+    HEAD = "HEAD"
+    OPTIONS = "OPTIONS"
+    TRACE = "TRACE"
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    DELETE = "DELETE"
+
+
+class AuthorizationType(str, Enum):
+    """
+    Authorization type options
+    """
+    O_AUTH2 = "OAuth2"
+    """
+    OAuth2 authorization type
+    """
+
+
+class BackendProtocol(str, Enum):
+    """
+    Backend communication protocol.
+    """
+    HTTP = "http"
+    """
+    The Backend is a RESTful service.
+    """
+    SOAP = "soap"
+    """
+    The Backend is a SOAP service.
+    """
+
+
+class BackendType(str, Enum):
+    """
+    Type of the backend. A backend can be either Single or Pool.
+    """
+    SINGLE = "Single"
+    """
+    supports single backend
+    """
+    POOL = "Pool"
+    """
+    supports pool backend
+    """
+
+
+class BearerTokenSendingMethod(str, Enum):
+    AUTHORIZATION_HEADER = "authorizationHeader"
+    QUERY = "query"
+
+
+class BearerTokenSendingMethods(str, Enum):
+    """
+    Form of an authorization grant, which the client uses to request the access token.
+    """
+    AUTHORIZATION_HEADER = "authorizationHeader"
+    """
+    Access token will be transmitted in the Authorization header using Bearer schema
+    """
+    QUERY = "query"
+    """
+    Access token will be transmitted as query parameters.
+    """
+
+
+class CertificateSource(str, Enum):
+    """
+    Certificate Source.
+    """
+    MANAGED = "Managed"
+    KEY_VAULT = "KeyVault"
+    CUSTOM = "Custom"
+    BUILT_IN = "BuiltIn"
+
+
+class CertificateStatus(str, Enum):
+    """
+    Certificate Status.
+    """
+    COMPLETED = "Completed"
+    FAILED = "Failed"
+    IN_PROGRESS = "InProgress"
+
+
+class ClientAuthenticationMethod(str, Enum):
+    BASIC = "Basic"
+    """
+    Basic Client Authentication method.
+    """
+    BODY = "Body"
+    """
+    Body based Authentication method.
+    """
+
+
+class Confirmation(str, Enum):
+    """
+    Determines the type of confirmation e-mail that will be sent to the newly created user.
+    """
+    SIGNUP = "signup"
+    """
+    Send an e-mail to the user confirming they have successfully signed up.
+    """
+    INVITE = "invite"
+    """
+    Send an e-mail inviting the user to sign-up and complete registration.
+    """
+
+
+class ContentFormat(str, Enum):
+    """
+    Format of the Content in which the API is getting imported. New formats can be added in the future
+    """
+    WADL_XML = "wadl-xml"
+    """
+    The contents are inline and Content type is a WADL document.
+    """
+    WADL_LINK_JSON = "wadl-link-json"
+    """
+    The WADL document is hosted on a publicly accessible internet address.
+    """
+    SWAGGER_JSON = "swagger-json"
+    """
+    The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
+    """
+    SWAGGER_LINK_JSON = "swagger-link-json"
+    """
+    The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
+    """
+    WSDL = "wsdl"
+    """
+    The contents are inline and the document is a WSDL/Soap document.
+    """
+    WSDL_LINK = "wsdl-link"
+    """
+    The WSDL document is hosted on a publicly accessible internet address.
+    """
+    OPENAPI = "openapi"
+    """
+    The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
+    """
+    OPENAPI_JSON = "openapi+json"
+    """
+    The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
+    """
+    OPENAPI_LINK = "openapi-link"
+    """
+    The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
+    """
+    OPENAPI_JSON_LINK = "openapi+json-link"
+    """
+    The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
+    """
+    GRAPHQL_LINK = "graphql-link"
+    """
+    The GraphQL API endpoint hosted on a publicly accessible internet address.
+    """
+    ODATA = "odata"
+    """
+    The contents are inline and Content Type is a OData XML Document.
+    """
+    ODATA_LINK = "odata-link"
+    """
+    The OData metadata document hosted on a publicly accessible internet address.
+    """
+    GRPC = "grpc"
+    """
+    The contents are inline and Content Type is a gRPC protobuf file.
+    """
+    GRPC_LINK = "grpc-link"
+    """
+    The gRPC protobuf file is hosted on a publicly accessible internet address.
+    """
+
+
+class DataMaskingMode(str, Enum):
+    """
+    Data masking mode.
+    """
+    MASK = "Mask"
+    """
+    Mask the value of an entity.
+    """
+    HIDE = "Hide"
+    """
+    Hide the presence of an entity.
+    """
+
+
+class DeveloperPortalStatus(str, Enum):
+    """
+    Status of developer portal in this API Management service.
+    """
+    ENABLED = "Enabled"
+    """
+    Developer Portal is enabled for the service.
+    """
+    DISABLED = "Disabled"
+    """
+    Developer Portal is disabled for the service.
+    """
+
+
+class GatewayListDebugCredentialsContractPurpose(str, Enum):
+    """
+    Purpose of debug credential.
+    """
+    TRACING = "tracing"
+    """
+    The tracing purpose.
+    """
+
+
+class GrantType(str, Enum):
+    AUTHORIZATION_CODE = "authorizationCode"
+    """
+    Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
+    """
+    IMPLICIT = "implicit"
+    """
+    Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
+    """
+    RESOURCE_OWNER_PASSWORD = "resourceOwnerPassword"
+    """
+    Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
+    """
+    CLIENT_CREDENTIALS = "clientCredentials"
+    """
+    Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
+    """
+
+
+class GroupType(str, Enum):
+    """
+    Group type.
+    """
+    CUSTOM = "custom"
+    SYSTEM = "system"
+    EXTERNAL = "external"
+
+
+class HostnameType(str, Enum):
+    """
+    Hostname type.
+    """
+    PROXY = "Proxy"
+    PORTAL = "Portal"
+    MANAGEMENT = "Management"
+    SCM = "Scm"
+    DEVELOPER_PORTAL = "DeveloperPortal"
+    CONFIGURATION_API = "ConfigurationApi"
+
+
+class HttpCorrelationProtocol(str, Enum):
+    """
+    Sets correlation protocol to use for Application Insights diagnostics.
+    """
+    NONE = "None"
+    """
+    Do not read and inject correlation headers.
+    """
+    LEGACY = "Legacy"
+    """
+    Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
+    """
+    W3_C = "W3C"
+    """
+    Inject Trace Context headers. See https://w3c.github.io/trace-context.
+    """
+
+
+class IdentityProviderType(str, Enum):
+    """
+    Identity Provider Type identifier.
+    """
+    FACEBOOK = "facebook"
+    """
+    Facebook as Identity provider.
+    """
+    GOOGLE = "google"
+    """
+    Google as Identity provider.
+    """
+    MICROSOFT = "microsoft"
+    """
+    Microsoft Live as Identity provider.
+    """
+    TWITTER = "twitter"
+    """
+    Twitter as Identity provider.
+    """
+    AAD = "aad"
+    """
+    Azure Active Directory as Identity provider.
+    """
+    AAD_B2_C = "aadB2C"
+    """
+    Azure Active Directory B2C as Identity provider.
+    """
+
+
+class KeyType(str, Enum):
+    """
+    The Key to be used to generate token for user.
+    """
+    PRIMARY = "primary"
+    SECONDARY = "secondary"
+
+
+class LegacyApiState(str, Enum):
+    """
+    Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'
+    """
+    ENABLED = "Enabled"
+    """
+    Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it.
+    """
+    DISABLED = "Disabled"
+    """
+    Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it.
+    """
+
+
+class LegacyPortalStatus(str, Enum):
+    """
+    Status of legacy portal in the API Management service.
+    """
+    ENABLED = "Enabled"
+    """
+    Legacy Portal is enabled for the service.
+    """
+    DISABLED = "Disabled"
+    """
+    Legacy Portal is disabled for the service.
+    """
+
+
+class LoggerType(str, Enum):
+    """
+    Logger type.
+    """
+    AZURE_EVENT_HUB = "azureEventHub"
+    """
+    Azure Event Hub as log destination.
+    """
+    APPLICATION_INSIGHTS = "applicationInsights"
+    """
+    Azure Application Insights as log destination.
+    """
+    AZURE_MONITOR = "azureMonitor"
+    """
+    Azure Monitor
+    """
+
+
+class NatGatewayState(str, Enum):
+    """
+    Property can be used to enable NAT Gateway for this API Management service.
+    """
+    ENABLED = "Enabled"
+    """
+    Nat Gateway is enabled for the service.
+    """
+    DISABLED = "Disabled"
+    """
+    Nat Gateway is disabled for the service.
+    """
+
+
+class OAuth2GrantType(str, Enum):
+    """
+    OAuth2 grant type options
+    """
+    AUTHORIZATION_CODE = "AuthorizationCode"
+    """
+    Authorization Code grant
+    """
+    CLIENT_CREDENTIALS = "ClientCredentials"
+    """
+    Client Credential grant
+    """
+
+
+class OperationNameFormat(str, Enum):
+    """
+    The format of the Operation Name for Application Insights telemetries. Default is Name.
+    """
+    NAME = "Name"
+    """
+    API_NAME;rev=API_REVISION - OPERATION_NAME
+    """
+    URL = "Url"
+    """
+    HTTP_VERB URL
+    """
+
+
+class PolicyContentFormat(str, Enum):
+    """
+    Format of the policyContent.
+    """
+    XML = "xml"
+    """
+    The contents are inline and Content type is an XML document.
+    """
+    XML_LINK = "xml-link"
+    """
+    The policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
+    """
+    RAWXML = "rawxml"
+    """
+    The contents are inline and Content type is a non XML encoded policy document.
+    """
+    RAWXML_LINK = "rawxml-link"
+    """
+    The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
+    """
+
+
+class PolicyFragmentContentFormat(str, Enum):
+    """
+    Format of the policy fragment content.
+    """
+    XML = "xml"
+    """
+    The contents are inline and Content type is an XML document.
+    """
+    RAWXML = "rawxml"
+    """
+    The contents are inline and Content type is a non XML encoded policy document.
+    """
+
+
+class PolicyRestrictionRequireBase(str, Enum):
+    """
+    Indicates if base policy should be enforced for the policy document.
+    """
+    TRUE = "true"
+    """
+    The policy is required to have base policy
+    """
+    FALSE = "false"
+    """
+    The policy does not require to have base policy
+    """
+
+
+class PrivateEndpointServiceConnectionStatus(str, Enum):
+    """
+    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
+    """
+    PENDING = "Pending"
+    APPROVED = "Approved"
+    REJECTED = "Rejected"
+
+
+class ProductState(str, Enum):
+    """
+    whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
+    """
+    NOT_PUBLISHED = "notPublished"
+    PUBLISHED = "published"
+
+
+class Protocol(str, Enum):
+    HTTP = "http"
+    HTTPS = "https"
+    WS = "ws"
+    WSS = "wss"
+
+
+class ProvisioningState(str, Enum):
+    """
+    Provisioning state.
+    """
+    CREATED = "created"
+
+
+class PublicNetworkAccess(str, Enum):
+    """
+    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'
+    """
+    ENABLED = "Enabled"
+    DISABLED = "Disabled"
+
+
+class SamplingType(str, Enum):
+    """
+    Sampling type.
+    """
+    FIXED = "fixed"
+    """
+    Fixed-rate sampling.
+    """
+
+
+class SchemaType(str, Enum):
+    """
+    Schema Type. Immutable.
+    """
+    XML = "xml"
+    """
+    XML schema type.
+    """
+    JSON = "json"
+    """
+    Json schema type.
+    """
+
+
+class SkuType(str, Enum):
+    """
+    Name of the Sku.
+    """
+    DEVELOPER = "Developer"
+    """
+    Developer SKU of Api Management.
+    """
+    STANDARD = "Standard"
+    """
+    Standard SKU of Api Management.
+    """
+    PREMIUM = "Premium"
+    """
+    Premium SKU of Api Management.
+    """
+    BASIC = "Basic"
+    """
+    Basic SKU of Api Management.
+    """
+    CONSUMPTION = "Consumption"
+    """
+    Consumption SKU of Api Management.
+    """
+    ISOLATED = "Isolated"
+    """
+    Isolated SKU of Api Management.
+    """
+    BASIC_V2 = "BasicV2"
+    """
+    BasicV2 SKU of Api Management.
+    """
+    STANDARD_V2 = "StandardV2"
+    """
+    StandardV2 SKU of Api Management.
+    """
+
+
+class SoapApiType(str, Enum):
+    """
+    Type of API to create. 
+     * `http` creates a REST API 
+     * `soap` creates a SOAP pass-through API  
+     * `websocket` creates websocket API 
+     * `graphql` creates GraphQL API. 
+     New types can be added in the future.
+    """
+    SOAP_TO_REST = "http"
+    """
+    Imports a SOAP API having a RESTful front end.
+    """
+    SOAP_PASS_THROUGH = "soap"
+    """
+    Imports the SOAP API having a SOAP front end.
+    """
+    WEB_SOCKET = "websocket"
+    """
+    Imports the API having a Websocket front end.
+    """
+    GRAPH_QL = "graphql"
+    """
+    Imports the API having a GraphQL front end.
+    """
+    O_DATA = "odata"
+    """
+    Imports the API having a OData front end.
+    """
+    G_RPC = "grpc"
+    """
+    Imports the API having a gRPC front end.
+    """
+
+
+class State(str, Enum):
+    """
+    Status of the issue.
+    """
+    PROPOSED = "proposed"
+    """
+    The issue is proposed.
+    """
+    OPEN = "open"
+    """
+    The issue is opened.
+    """
+    REMOVED = "removed"
+    """
+    The issue was removed.
+    """
+    RESOLVED = "resolved"
+    """
+    The issue is now resolved.
+    """
+    CLOSED = "closed"
+    """
+    The issue was closed.
+    """
+
+
+class SubscriptionState(str, Enum):
+    """
+    Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
+    """
+    SUSPENDED = "suspended"
+    ACTIVE = "active"
+    EXPIRED = "expired"
+    SUBMITTED = "submitted"
+    REJECTED = "rejected"
+    CANCELLED = "cancelled"
+
+
+class TranslateRequiredQueryParametersConduct(str, Enum):
+    """
+    Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
+    """
+    TEMPLATE = "template"
+    """
+    Translates required query parameters to template ones. Is a default value
+    """
+    QUERY = "query"
+    """
+    Leaves required query parameters as they are (no translation done).
+    """
+
+
+class UserState(str, Enum):
+    """
+    Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
+    """
+    ACTIVE = "active"
+    """
+    User state is active.
+    """
+    BLOCKED = "blocked"
+    """
+    User is blocked. Blocked users cannot authenticate at developer portal or call API.
+    """
+    PENDING = "pending"
+    """
+    User account is pending. Requires identity confirmation before it can be made active.
+    """
+    DELETED = "deleted"
+    """
+    User account is closed. All identities and related entities are removed.
+    """
+
+
+class Verbosity(str, Enum):
+    """
+    The verbosity level applied to traces emitted by trace policies.
+    """
+    VERBOSE = "verbose"
+    """
+    All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
+    """
+    INFORMATION = "information"
+    """
+    Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
+    """
+    ERROR = "error"
+    """
+    Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
+    """
+
+
+class VersioningScheme(str, Enum):
+    """
+    An value that determines where the API Version identifier will be located in a HTTP request.
+    """
+    SEGMENT = "Segment"
+    """
+    The API Version is passed in a path segment.
+    """
+    QUERY = "Query"
+    """
+    The API Version is passed in a query parameter.
+    """
+    HEADER = "Header"
+    """
+    The API Version is passed in a HTTP header.
+    """
+
+
+class VirtualNetworkType(str, Enum):
+    """
+    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.
+    """
+    NONE = "None"
+    """
+    The service is not part of any Virtual Network.
+    """
+    EXTERNAL = "External"
+    """
+    The service is part of Virtual Network and it is accessible from Internet.
+    """
+    INTERNAL = "Internal"
+    """
+    The service is part of Virtual Network and it is only accessible from within the virtual network.
+    """