Package com.microsoft.azure.management.appservice

Class AppServiceEnvironmentPatchResource

  • public class AppServiceEnvironmentPatchResource
extends ProxyOnlyResource
    ARM resource for a app service environment.

    • Constructor Detail

      • AppServiceEnvironmentPatchResource

        public AppServiceEnvironmentPatchResource()

    • Method Detail

      • appServiceEnvironmentPatchResourceName

        public String appServiceEnvironmentPatchResourceName()
        Get name of the App Service Environment.
        Returns:
        the appServiceEnvironmentPatchResourceName value

      • withAppServiceEnvironmentPatchResourceName

        public AppServiceEnvironmentPatchResource withAppServiceEnvironmentPatchResourceName​(String appServiceEnvironmentPatchResourceName)
        Set name of the App Service Environment.
        Parameters:
        appServiceEnvironmentPatchResourceName - the appServiceEnvironmentPatchResourceName value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • location

        public String location()
        Get location of the App Service Environment, e.g. "West US".
        Returns:
        the location value

      • withLocation

        public AppServiceEnvironmentPatchResource withLocation​(String location)
        Set location of the App Service Environment, e.g. "West US".
        Parameters:
        location - the location value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • provisioningState

        public ProvisioningState provisioningState()
        Get provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'.
        Returns:
        the provisioningState value

      • status

        public HostingEnvironmentStatus status()
        Get current status of the App Service Environment. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'.
        Returns:
        the status value

      • vnetName

        public String vnetName()
        Get name of the Virtual Network for the App Service Environment.
        Returns:
        the vnetName value

      • withVnetName

        public AppServiceEnvironmentPatchResource withVnetName​(String vnetName)
        Set name of the Virtual Network for the App Service Environment.
        Parameters:
        vnetName - the vnetName value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • vnetResourceGroupName

        public String vnetResourceGroupName()
        Get resource group of the Virtual Network.
        Returns:
        the vnetResourceGroupName value

      • withVnetResourceGroupName

        public AppServiceEnvironmentPatchResource withVnetResourceGroupName​(String vnetResourceGroupName)
        Set resource group of the Virtual Network.
        Parameters:
        vnetResourceGroupName - the vnetResourceGroupName value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • vnetSubnetName

        public String vnetSubnetName()
        Get subnet of the Virtual Network.
        Returns:
        the vnetSubnetName value

      • withVnetSubnetName

        public AppServiceEnvironmentPatchResource withVnetSubnetName​(String vnetSubnetName)
        Set subnet of the Virtual Network.
        Parameters:
        vnetSubnetName - the vnetSubnetName value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • virtualNetwork

        public VirtualNetworkProfile virtualNetwork()
        Get description of the Virtual Network.
        Returns:
        the virtualNetwork value

      • withVirtualNetwork

        public AppServiceEnvironmentPatchResource withVirtualNetwork​(VirtualNetworkProfile virtualNetwork)
        Set description of the Virtual Network.
        Parameters:
        virtualNetwork - the virtualNetwork value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • internalLoadBalancingMode

        public InternalLoadBalancingMode internalLoadBalancingMode()
        Get specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'.
        Returns:
        the internalLoadBalancingMode value

      • withInternalLoadBalancingMode

        public AppServiceEnvironmentPatchResource withInternalLoadBalancingMode​(InternalLoadBalancingMode internalLoadBalancingMode)
        Set specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'.
        Parameters:
        internalLoadBalancingMode - the internalLoadBalancingMode value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • multiSize

        public String multiSize()
        Get front-end VM size, e.g. "Medium", "Large".
        Returns:
        the multiSize value

      • withMultiSize

        public AppServiceEnvironmentPatchResource withMultiSize​(String multiSize)
        Set front-end VM size, e.g. "Medium", "Large".
        Parameters:
        multiSize - the multiSize value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • multiRoleCount

        public Integer multiRoleCount()
        Get number of front-end instances.
        Returns:
        the multiRoleCount value

      • withMultiRoleCount

        public AppServiceEnvironmentPatchResource withMultiRoleCount​(Integer multiRoleCount)
        Set number of front-end instances.
        Parameters:
        multiRoleCount - the multiRoleCount value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • workerPools

        public List<WorkerPool> workerPools()
        Get description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
        Returns:
        the workerPools value

      • withWorkerPools

        public AppServiceEnvironmentPatchResource withWorkerPools​(List<WorkerPool> workerPools)
        Set description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
        Parameters:
        workerPools - the workerPools value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • ipsslAddressCount

        public Integer ipsslAddressCount()
        Get number of IP SSL addresses reserved for the App Service Environment.
        Returns:
        the ipsslAddressCount value

      • withIpsslAddressCount

        public AppServiceEnvironmentPatchResource withIpsslAddressCount​(Integer ipsslAddressCount)
        Set number of IP SSL addresses reserved for the App Service Environment.
        Parameters:
        ipsslAddressCount - the ipsslAddressCount value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • databaseEdition

        public String databaseEdition()
        Get edition of the metadata database for the App Service Environment, e.g. "Standard".
        Returns:
        the databaseEdition value

      • databaseServiceObjective

        public String databaseServiceObjective()
        Get service objective of the metadata database for the App Service Environment, e.g. "S0".
        Returns:
        the databaseServiceObjective value

      • upgradeDomains

        public Integer upgradeDomains()
        Get number of upgrade domains of the App Service Environment.
        Returns:
        the upgradeDomains value

      • subscriptionId

        public String subscriptionId()
        Get subscription of the App Service Environment.
        Returns:
        the subscriptionId value

      • dnsSuffix

        public String dnsSuffix()
        Get dNS suffix of the App Service Environment.
        Returns:
        the dnsSuffix value

      • withDnsSuffix

        public AppServiceEnvironmentPatchResource withDnsSuffix​(String dnsSuffix)
        Set dNS suffix of the App Service Environment.
        Parameters:
        dnsSuffix - the dnsSuffix value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • lastAction

        public String lastAction()
        Get last deployment action on the App Service Environment.
        Returns:
        the lastAction value

      • lastActionResult

        public String lastActionResult()
        Get result of the last deployment action on the App Service Environment.
        Returns:
        the lastActionResult value

      • allowedMultiSizes

        public String allowedMultiSizes()
        Get list of comma separated strings describing which VM sizes are allowed for front-ends.
        Returns:
        the allowedMultiSizes value

      • allowedWorkerSizes

        public String allowedWorkerSizes()
        Get list of comma separated strings describing which VM sizes are allowed for workers.
        Returns:
        the allowedWorkerSizes value

      • maximumNumberOfMachines

        public Integer maximumNumberOfMachines()
        Get maximum number of VMs in the App Service Environment.
        Returns:
        the maximumNumberOfMachines value

      • vipMappings

        public List<VirtualIPMapping> vipMappings()
        Get description of IP SSL mapping for the App Service Environment.
        Returns:
        the vipMappings value

      • environmentCapacities

        public List<com.microsoft.azure.management.appservice.implementation.StampCapacityInner> environmentCapacities()
        Get current total, used, and available worker capacities.
        Returns:
        the environmentCapacities value

      • networkAccessControlList

        public List<NetworkAccessControlEntry> networkAccessControlList()
        Get access control list for controlling traffic to the App Service Environment.
        Returns:
        the networkAccessControlList value

      • withNetworkAccessControlList

        public AppServiceEnvironmentPatchResource withNetworkAccessControlList​(List<NetworkAccessControlEntry> networkAccessControlList)
        Set access control list for controlling traffic to the App Service Environment.
        Parameters:
        networkAccessControlList - the networkAccessControlList value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • environmentIsHealthy

        public Boolean environmentIsHealthy()
        Get true/false indicating whether the App Service Environment is healthy.
        Returns:
        the environmentIsHealthy value

      • environmentStatus

        public String environmentStatus()
        Get detailed message about with results of the last check of the App Service Environment.
        Returns:
        the environmentStatus value

      • resourceGroup

        public String resourceGroup()
        Get resource group of the App Service Environment.
        Returns:
        the resourceGroup value

      • frontEndScaleFactor

        public Integer frontEndScaleFactor()
        Get scale factor for front-ends.
        Returns:
        the frontEndScaleFactor value

      • withFrontEndScaleFactor

        public AppServiceEnvironmentPatchResource withFrontEndScaleFactor​(Integer frontEndScaleFactor)
        Set scale factor for front-ends.
        Parameters:
        frontEndScaleFactor - the frontEndScaleFactor value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • defaultFrontEndScaleFactor

        public Integer defaultFrontEndScaleFactor()
        Get default Scale Factor for FrontEnds.
        Returns:
        the defaultFrontEndScaleFactor value

      • apiManagementAccountId

        public String apiManagementAccountId()
        Get aPI Management Account associated with the App Service Environment.
        Returns:
        the apiManagementAccountId value

      • withApiManagementAccountId

        public AppServiceEnvironmentPatchResource withApiManagementAccountId​(String apiManagementAccountId)
        Set aPI Management Account associated with the App Service Environment.
        Parameters:
        apiManagementAccountId - the apiManagementAccountId value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • suspended

        public Boolean suspended()
        Get <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
        Returns:
        the suspended value

      • withSuspended

        public AppServiceEnvironmentPatchResource withSuspended​(Boolean suspended)
        Set <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
        Parameters:
        suspended - the suspended value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • dynamicCacheEnabled

        public Boolean dynamicCacheEnabled()
        Get true/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
        Returns:
        the dynamicCacheEnabled value

      • withDynamicCacheEnabled

        public AppServiceEnvironmentPatchResource withDynamicCacheEnabled​(Boolean dynamicCacheEnabled)
        Set true/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
        Parameters:
        dynamicCacheEnabled - the dynamicCacheEnabled value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • clusterSettings

        public List<NameValuePair> clusterSettings()
        Get custom settings for changing the behavior of the App Service Environment.
        Returns:
        the clusterSettings value

      • withClusterSettings

        public AppServiceEnvironmentPatchResource withClusterSettings​(List<NameValuePair> clusterSettings)
        Set custom settings for changing the behavior of the App Service Environment.
        Parameters:
        clusterSettings - the clusterSettings value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • userWhitelistedIpRanges

        public List<String> userWhitelistedIpRanges()
        Get user added ip ranges to whitelist on ASE db.
        Returns:
        the userWhitelistedIpRanges value

      • withUserWhitelistedIpRanges

        public AppServiceEnvironmentPatchResource withUserWhitelistedIpRanges​(List<String> userWhitelistedIpRanges)
        Set user added ip ranges to whitelist on ASE db.
        Parameters:
        userWhitelistedIpRanges - the userWhitelistedIpRanges value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • hasLinuxWorkers

        public Boolean hasLinuxWorkers()
        Get flag that displays whether an ASE has linux workers or not.
        Returns:
        the hasLinuxWorkers value

      • withHasLinuxWorkers

        public AppServiceEnvironmentPatchResource withHasLinuxWorkers​(Boolean hasLinuxWorkers)
        Set flag that displays whether an ASE has linux workers or not.
        Parameters:
        hasLinuxWorkers - the hasLinuxWorkers value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • sslCertKeyVaultId

        public String sslCertKeyVaultId()
        Get key Vault ID for ILB App Service Environment default SSL certificate.
        Returns:
        the sslCertKeyVaultId value

      • withSslCertKeyVaultId

        public AppServiceEnvironmentPatchResource withSslCertKeyVaultId​(String sslCertKeyVaultId)
        Set key Vault ID for ILB App Service Environment default SSL certificate.
        Parameters:
        sslCertKeyVaultId - the sslCertKeyVaultId value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.

      • sslCertKeyVaultSecretName

        public String sslCertKeyVaultSecretName()
        Get key Vault Secret Name for ILB App Service Environment default SSL certificate.
        Returns:
        the sslCertKeyVaultSecretName value

      • withSslCertKeyVaultSecretName

        public AppServiceEnvironmentPatchResource withSslCertKeyVaultSecretName​(String sslCertKeyVaultSecretName)
        Set key Vault Secret Name for ILB App Service Environment default SSL certificate.
        Parameters:
        sslCertKeyVaultSecretName - the sslCertKeyVaultSecretName value to set
        Returns:
        the AppServiceEnvironmentPatchResource object itself.