Package com.pulumi.azurenative.apimanagement

Class ApiManagementServiceArgs

  • public final class ApiManagementServiceArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • additionalLocations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<AdditionalLocationArgs>>> additionalLocations()
        Returns:
        Additional datacenter locations of the API Management service.

      • apiVersionConstraint

        public java.util.Optional<com.pulumi.core.Output<ApiVersionConstraintArgs>> apiVersionConstraint()
        Returns:
        Control Plane Apis version constraint for the API Management service.

      • certificates

        public java.util.Optional<com.pulumi.core.Output<java.util.List<CertificateConfigurationArgs>>> certificates()
        Returns:
        List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

      • customProperties

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> customProperties()
        Returns:
        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

      • disableGateway

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disableGateway()
        Returns:
        Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

      • enableClientCertificate

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableClientCertificate()
        Returns:
        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.

      • hostnameConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<HostnameConfigurationArgs>>> hostnameConfigurations()
        Returns:
        Custom hostname configuration of the API Management service.

      • identity

        public java.util.Optional<com.pulumi.core.Output<ApiManagementServiceIdentityArgs>> identity()
        Returns:
        Managed service identity of the Api Management service.

      • location

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> location()
        Returns:
        Resource location.

      • natGatewayState

        public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​NatGatewayState>>> natGatewayState()
        Returns:
        Property can be used to enable NAT Gateway for this API Management service.

      • notificationSenderEmail

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> notificationSenderEmail()
        Returns:
        Email address from which the notification will be sent.

      • privateEndpointConnections

        public java.util.Optional<com.pulumi.core.Output<java.util.List<RemotePrivateEndpointConnectionWrapperArgs>>> privateEndpointConnections()
        Returns:
        List of Private Endpoint Connections of this service.

      • publicIpAddressId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> publicIpAddressId()
        Returns:
        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.

      • publicNetworkAccess

        public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​PublicNetworkAccess>>> publicNetworkAccess()
        Returns:
        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'

      • publisherEmail

        public com.pulumi.core.Output<java.lang.String> publisherEmail()
        Returns:
        Publisher email.

      • publisherName

        public com.pulumi.core.Output<java.lang.String> publisherName()
        Returns:
        Publisher name.

      • resourceGroupName

        public com.pulumi.core.Output<java.lang.String> resourceGroupName()
        Returns:
        The name of the resource group. The name is case insensitive.

      • restore

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> restore()
        Returns:
        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.

      • serviceName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> serviceName()
        Returns:
        The name of the API Management service.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Resource tags.

      • virtualNetworkConfiguration

        public java.util.Optional<com.pulumi.core.Output<VirtualNetworkConfigurationArgs>> virtualNetworkConfiguration()
        Returns:
        Virtual network configuration of the API Management service.

      • virtualNetworkType

        public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​VirtualNetworkType>>> virtualNetworkType()
        Returns:
        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.

      • zones

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> zones()
        Returns:
        A list of availability zones denoting where the resource needs to come from.