class Azure::Web::Mgmt::V2018_02_01::Models::AppServiceEnvironmentPatchResource

ARM resource for a app service enviroment.

Attributes

allowed_multi_sizes[RW]

@return [String] List of comma separated strings describing which VM sizes are allowed for front-ends.

allowed_worker_sizes[RW]

@return [String] List of comma separated strings describing which VM sizes are allowed for workers.

api_management_account_id[RW]

@return [String] API Management Account associated with the App Service Environment.

app_service_environment_patch_resource_name[RW]

@return [String] Name of the App Service Environment.

cluster_settings[RW]

@return [Array<NameValuePair>] Custom settings for changing the behavior of the App Service Environment.

database_edition[RW]

@return [String] Edition of the metadata database for the App Service Environment, e.g. “Standard”.

database_service_objective[RW]

@return [String] Service objective of the metadata database for the App Service Environment, e.g. “S0”.

default_front_end_scale_factor[RW]

@return [Integer] Default Scale Factor for FrontEnds.

dns_suffix[RW]

@return [String] DNS suffix of the App Service Environment.

dynamic_cache_enabled[RW]

@return [Boolean] 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).

environment_capacities[RW]

@return [Array<StampCapacity>] Current total, used, and available worker capacities.

environment_is_healthy[RW]

@return [Boolean] True/false indicating whether the App Service Environment is healthy.

environment_status[RW]

@return [String] Detailed message about with results of the last check of the App Service Environment.

front_end_scale_factor[RW]

@return [Integer] Scale factor for front-ends.

has_linux_workers[RW]

@return [Boolean] Flag that displays whether an ASE has linux workers or not

internal_load_balancing_mode[RW]

@return [InternalLoadBalancingMode] Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'

ipssl_address_count[RW]

@return [Integer] Number of IP SSL addresses reserved for the App Service Environment.

last_action[RW]

@return [String] Last deployment action on the App Service Environment.

last_action_result[RW]

@return [String] Result of the last deployment action on the App Service Environment.

location[RW]

@return [String] Location of the App Service Environment, e.g. “West US”.

maximum_number_of_machines[RW]

@return [Integer] Maximum number of VMs in the App Service Environment.

multi_role_count[RW]

@return [Integer] Number of front-end instances.

multi_size[RW]

@return [String] Front-end VM size, e.g. “Medium”, “Large”.

network_access_control_list[RW]

@return [Array<NetworkAccessControlEntry>] Access control list for controlling traffic to the App Service Environment.

provisioning_state[RW]

@return [ProvisioningState] Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'

resource_group[RW]

@return [String] Resource group of the App Service Environment.

ssl_cert_key_vault_id[RW]

@return [String] Key Vault ID for ILB App Service Environment default SSL certificate

ssl_cert_key_vault_secret_name[RW]

@return [String] Key Vault Secret Name for ILB App Service Environment default SSL certificate

status[RW]

@return [HostingEnvironmentStatus] Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'

subscription_id[RW]

@return [String] Subscription of the App Service Environment.

suspended[RW]

@return [Boolean] true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

upgrade_domains[RW]

@return [Integer] Number of upgrade domains of the App Service Environment.

user_whitelisted_ip_ranges[RW]

@return [Array<String>] User added ip ranges to whitelist on ASE db

vip_mappings[RW]

@return [Array<VirtualIPMapping>] Description of IP SSL mapping for the App Service Environment.

virtual_network[RW]

@return [VirtualNetworkProfile] Description of the Virtual Network.

vnet_name[RW]

@return [String] Name of the Virtual Network for the App Service Environment.

vnet_resource_group_name[RW]

@return [String] Resource group of the Virtual Network.

vnet_subnet_name[RW]

@return [String] Subnet of the Virtual Network.

worker_pools[RW]

@return [Array<WorkerPool>] Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

Private Class Methods

mapper() click to toggle source

Mapper for AppServiceEnvironmentPatchResource class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb, line 169
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'AppServiceEnvironmentPatchResource',
    type: {
      name: 'Composite',
      class_name: 'AppServiceEnvironmentPatchResource',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        app_service_environment_patch_resource_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.name',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.location',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'HostingEnvironmentStatus'
          }
        },
        vnet_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vnetName',
          type: {
            name: 'String'
          }
        },
        vnet_resource_group_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vnetResourceGroupName',
          type: {
            name: 'String'
          }
        },
        vnet_subnet_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vnetSubnetName',
          type: {
            name: 'String'
          }
        },
        virtual_network: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.virtualNetwork',
          type: {
            name: 'Composite',
            class_name: 'VirtualNetworkProfile'
          }
        },
        internal_load_balancing_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.internalLoadBalancingMode',
          type: {
            name: 'Enum',
            module: 'InternalLoadBalancingMode'
          }
        },
        multi_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.multiSize',
          type: {
            name: 'String'
          }
        },
        multi_role_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.multiRoleCount',
          type: {
            name: 'Number'
          }
        },
        worker_pools: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.workerPools',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'WorkerPoolElementType',
                type: {
                  name: 'Composite',
                  class_name: 'WorkerPool'
                }
            }
          }
        },
        ipssl_address_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipsslAddressCount',
          type: {
            name: 'Number'
          }
        },
        database_edition: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.databaseEdition',
          type: {
            name: 'String'
          }
        },
        database_service_objective: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.databaseServiceObjective',
          type: {
            name: 'String'
          }
        },
        upgrade_domains: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.upgradeDomains',
          type: {
            name: 'Number'
          }
        },
        subscription_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.subscriptionId',
          type: {
            name: 'String'
          }
        },
        dns_suffix: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsSuffix',
          type: {
            name: 'String'
          }
        },
        last_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastAction',
          type: {
            name: 'String'
          }
        },
        last_action_result: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastActionResult',
          type: {
            name: 'String'
          }
        },
        allowed_multi_sizes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allowedMultiSizes',
          type: {
            name: 'String'
          }
        },
        allowed_worker_sizes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allowedWorkerSizes',
          type: {
            name: 'String'
          }
        },
        maximum_number_of_machines: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.maximumNumberOfMachines',
          type: {
            name: 'Number'
          }
        },
        vip_mappings: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.vipMappings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VirtualIPMappingElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VirtualIPMapping'
                }
            }
          }
        },
        environment_capacities: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.environmentCapacities',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StampCapacityElementType',
                type: {
                  name: 'Composite',
                  class_name: 'StampCapacity'
                }
            }
          }
        },
        network_access_control_list: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkAccessControlList',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NetworkAccessControlEntryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NetworkAccessControlEntry'
                }
            }
          }
        },
        environment_is_healthy: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.environmentIsHealthy',
          type: {
            name: 'Boolean'
          }
        },
        environment_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.environmentStatus',
          type: {
            name: 'String'
          }
        },
        resource_group: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceGroup',
          type: {
            name: 'String'
          }
        },
        front_end_scale_factor: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.frontEndScaleFactor',
          type: {
            name: 'Number'
          }
        },
        default_front_end_scale_factor: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultFrontEndScaleFactor',
          type: {
            name: 'Number'
          }
        },
        api_management_account_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiManagementAccountId',
          type: {
            name: 'String'
          }
        },
        suspended: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.suspended',
          type: {
            name: 'Boolean'
          }
        },
        dynamic_cache_enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dynamicCacheEnabled',
          type: {
            name: 'Boolean'
          }
        },
        cluster_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clusterSettings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NameValuePairElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NameValuePair'
                }
            }
          }
        },
        user_whitelisted_ip_ranges: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userWhitelistedIpRanges',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        has_linux_workers: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hasLinuxWorkers',
          type: {
            name: 'Boolean'
          }
        },
        ssl_cert_key_vault_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sslCertKeyVaultId',
          type: {
            name: 'String'
          }
        },
        ssl_cert_key_vault_secret_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sslCertKeyVaultSecretName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end