Class ApiManagementServiceUpdateProperties

    • Constructor Detail

      • ApiManagementServiceUpdateProperties

        public ApiManagementServiceUpdateProperties()
    • Method Detail

      • publisherEmail

        public String publisherEmail()
        Get the publisherEmail property: Publisher email.
        Returns:
        the publisherEmail value.
      • withPublisherEmail

        public ApiManagementServiceUpdateProperties withPublisherEmail​(String publisherEmail)
        Set the publisherEmail property: Publisher email.
        Parameters:
        publisherEmail - the publisherEmail value to set.
        Returns:
        the ApiManagementServiceUpdateProperties object itself.
      • publisherName

        public String publisherName()
        Get the publisherName property: Publisher name.
        Returns:
        the publisherName value.
      • withPublisherName

        public ApiManagementServiceUpdateProperties withPublisherName​(String publisherName)
        Set the publisherName property: Publisher name.
        Parameters:
        publisherName - the publisherName value to set.
        Returns:
        the ApiManagementServiceUpdateProperties object itself.
      • withPublicIpAddressId

        public ApiManagementServiceUpdateProperties withPublicIpAddressId​(String publicIpAddressId)
        Set the publicIpAddressId property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
        Overrides:
        withPublicIpAddressId in class ApiManagementServiceBaseProperties
        Parameters:
        publicIpAddressId - the publicIpAddressId value to set.
        Returns:
        the ApiManagementServiceBaseProperties object itself.
      • withPublicNetworkAccess

        public ApiManagementServiceUpdateProperties withPublicNetworkAccess​(PublicNetworkAccess publicNetworkAccess)
        Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'.
        Overrides:
        withPublicNetworkAccess in class ApiManagementServiceBaseProperties
        Parameters:
        publicNetworkAccess - the publicNetworkAccess value to set.
        Returns:
        the ApiManagementServiceBaseProperties object itself.
      • withCustomProperties

        public ApiManagementServiceUpdateProperties withCustomProperties​(Map<String,​String> customProperties)
        Set the customProperties property: Custom properties of the API Management service.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.</br>Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1st 2018 and `False` otherwise. Http2 setting's default value is `False`.</br></br>You can disable any of next 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. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: 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,TLS_RSA_WITH_AES_256_GCM_SHA384.
        Overrides:
        withCustomProperties in class ApiManagementServiceBaseProperties
        Parameters:
        customProperties - the customProperties value to set.
        Returns:
        the ApiManagementServiceBaseProperties object itself.
      • withEnableClientCertificate

        public ApiManagementServiceUpdateProperties withEnableClientCertificate​(Boolean enableClientCertificate)
        Set the enableClientCertificate property: Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
        Overrides:
        withEnableClientCertificate in class ApiManagementServiceBaseProperties
        Parameters:
        enableClientCertificate - the enableClientCertificate value to set.
        Returns:
        the ApiManagementServiceBaseProperties object itself.
      • withDisableGateway

        public ApiManagementServiceUpdateProperties withDisableGateway​(Boolean disableGateway)
        Set the disableGateway property: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
        Overrides:
        withDisableGateway in class ApiManagementServiceBaseProperties
        Parameters:
        disableGateway - the disableGateway value to set.
        Returns:
        the ApiManagementServiceBaseProperties object itself.
      • withVirtualNetworkType

        public ApiManagementServiceUpdateProperties withVirtualNetworkType​(VirtualNetworkType virtualNetworkType)
        Set the virtualNetworkType property: The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
        Overrides:
        withVirtualNetworkType in class ApiManagementServiceBaseProperties
        Parameters:
        virtualNetworkType - the virtualNetworkType value to set.
        Returns:
        the ApiManagementServiceBaseProperties object itself.
      • withRestore

        public ApiManagementServiceUpdateProperties withRestore​(Boolean restore)
        Set the restore property: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
        Overrides:
        withRestore in class ApiManagementServiceBaseProperties
        Parameters:
        restore - the restore value to set.
        Returns:
        the ApiManagementServiceBaseProperties object itself.