SiteProperties Class

Site resource specific properties.

Constructor

SiteProperties(*args: Any, **kwargs: Any)

Variables

Name	Description
state	str Current state of the app.
host_names	list[str] Hostnames associated with the app.
repository_site_name	str Name of the repository site.
usage_state	str or UsageState State indicating whether the app has exceeded its quota usage. Read-only. Known values are: "Normal" and "Exceeded".
enabled	bool true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
enabled_host_names	list[str] Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.
availability_state	str or SiteAvailabilityState Management information availability state for the app. Known values are: "Normal", "Limited", and "DisasterRecoveryMode".
host_name_ssl_states	list[HostNameSslState] Hostname SSL states are used to manage the SSL bindings for app's hostnames.
server_farm_id	str Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
reserved	bool true if reserved; otherwise, false.
is_xenon	bool Obsolete: Hyper-V sandbox.
hyper_v	bool Hyper-V sandbox.
last_modified_time_utc	datetime Last time the app was modified, in UTC. Read-only.
dns_configuration	SiteDnsConfig Property to configure various DNS related settings for a site.
outbound_vnet_routing	OutboundVnetRouting Property to configure various outbound traffic routing options over virtual network for a site.
site_config	SiteConfig Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information.
function_app_config	FunctionAppConfig Configuration specific of the Azure Function app.
dapr_config	DaprConfig Dapr configuration of the app.
workload_profile_name	str Workload profile name for function app to execute on.
resource_config	ResourceConfig Function app resource requirements.
traffic_manager_host_names	list[str] Azure Traffic Manager hostnames associated with the app. Read-only.
scm_site_also_stopped	bool true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
target_swap_slot	str Specifies which deployment slot this app will swap into. Read-only.
hosting_environment_profile	HostingEnvironmentProfile App Service Environment to use for the app.
client_affinity_enabled	bool true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.
client_affinity_partitioning_enabled	bool true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false.
client_affinity_proxy_enabled	bool true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false.
client_cert_enabled	bool true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.
client_cert_mode	str or ClientCertMode This composes with ClientCertEnabled setting. ClientCertEnabled: false means ClientCert is ignored. ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. Known values are: "Required", "Optional", and "OptionalInteractiveUser".
client_cert_exclusion_paths	str client certificate authentication comma-separated exclusion paths.
ip_mode	str or IPMode Specifies the IP mode of the app. Known values are: "IPv4", "IPv6", and "IPv4AndIPv6".
end_to_end_encryption_enabled	bool Whether to use end to end encryption between the FrontEnd and the Worker.
ssh_enabled	bool Whether to enable ssh access.
host_names_disabled	bool true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.
custom_domain_verification_id	str Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
outbound_ip_addresses	str List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
possible_outbound_ip_addresses	str List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.
container_size	int Size of the function container.
daily_memory_time_quota	int Maximum allowed daily memory-time quota (applicable on dynamic apps only).
suspended_till	datetime App suspended till in case memory-time quota is exceeded.
max_number_of_workers	int Maximum number of workers. This only applies to Functions container.
cloning_info	CloningInfo If specified during app creation, the app is cloned from a source app.
resource_group	str Name of the resource group the app belongs to. Read-only.
is_default_container	bool true if the app is a default container; otherwise, false.
default_host_name	str Default hostname of the app. Read-only.
slot_swap_status	SlotSwapStatus Status of the last deployment slot swap operation.
https_only	bool HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests.
redundancy_mode	str or RedundancyMode Site redundancy mode. Known values are: "None", "Manual", "Failover", "ActiveActive", and "GeoRedundant".
in_progress_operation_id	str Specifies an operation id if this site has a pending operation.
public_network_access	str Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.
storage_account_required	bool Checks if Customer provided storage account is required.
key_vault_reference_identity	str Identity to use for Key Vault Reference authentication.
auto_generated_domain_name_label_scope	str or AutoGeneratedDomainNameLabelScope Specifies the scope of uniqueness for the default hostname during resource creation. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse".
virtual_network_subnet_id	str Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.
managed_environment_id	str Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}.
sku	str Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2.

Attributes

auto_generated_domain_name_label_scope

Specifies the scope of uniqueness for the default hostname during resource creation. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse".

auto_generated_domain_name_label_scope: str | _models.AutoGeneratedDomainNameLabelScope | None

availability_state

"Normal", "Limited", and "DisasterRecoveryMode".

availability_state: str | _models.SiteAvailabilityState | None

client_affinity_enabled

true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

client_affinity_enabled: bool | None

client_affinity_partitioning_enabled

true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false.

client_affinity_partitioning_enabled: bool | None

client_affinity_proxy_enabled

true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false.

client_affinity_proxy_enabled: bool | None

client_cert_enabled

true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

client_cert_enabled: bool | None

client_cert_exclusion_paths

client certificate authentication comma-separated exclusion paths.

client_cert_exclusion_paths: str | None

client_cert_mode

This composes with ClientCertEnabled setting.

• ClientCertEnabled: false means ClientCert is ignored.

• ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.

• ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. Known values are: "Required", "Optional", and "OptionalInteractiveUser".

client_cert_mode: str | _models.ClientCertMode | None

cloning_info

If specified during app creation, the app is cloned from a source app.

cloning_info: _models.CloningInfo | None

container_size

Size of the function container.

container_size: int | None

custom_domain_verification_id

Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

custom_domain_verification_id: str | None

daily_memory_time_quota

Maximum allowed daily memory-time quota (applicable on dynamic apps only).

daily_memory_time_quota: int | None

dapr_config

Dapr configuration of the app.

dapr_config: _models.DaprConfig | None

default_host_name

Default hostname of the app. Read-only.

default_host_name: str | None

dns_configuration

Property to configure various DNS related settings for a site.

dns_configuration: _models.SiteDnsConfig | None

enabled

true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

enabled: bool | None

enabled_host_names

Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

enabled_host_names: list[str] | None

end_to_end_encryption_enabled

Whether to use end to end encryption between the FrontEnd and the Worker.

end_to_end_encryption_enabled: bool | None

function_app_config

Configuration specific of the Azure Function app.

function_app_config: _models.FunctionAppConfig | None

host_name_ssl_states

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

host_name_ssl_states: list['_models.HostNameSslState'] | None

host_names

Hostnames associated with the app.

host_names: list[str] | None

host_names_disabled

true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

host_names_disabled: bool | None

hosting_environment_profile

App Service Environment to use for the app.

hosting_environment_profile: _models.HostingEnvironmentProfile | None

https_only

configures a web site to accept only https requests. Issues redirect for http requests.

https_only: bool | None

hyper_v

Hyper-V sandbox.

hyper_v: bool | None

in_progress_operation_id

Specifies an operation id if this site has a pending operation.

in_progress_operation_id: str | None

ip_mode

"IPv4", "IPv6", and "IPv4AndIPv6".

ip_mode: str | _models.IPMode | None

is_default_container

true if the app is a default container; otherwise, false.

is_default_container: bool | None

is_xenon

Hyper-V sandbox.

is_xenon: bool | None

key_vault_reference_identity

Identity to use for Key Vault Reference authentication.

key_vault_reference_identity: str | None

last_modified_time_utc

Last time the app was modified, in UTC. Read-only.

last_modified_time_utc: datetime | None

managed_environment_id

Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}.

managed_environment_id: str | None

max_number_of_workers

Maximum number of workers. This only applies to Functions container.

max_number_of_workers: int | None

outbound_ip_addresses

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.

outbound_ip_addresses: str | None

outbound_vnet_routing

Property to configure various outbound traffic routing options over virtual network for a site.

outbound_vnet_routing: _models.OutboundVnetRouting | None

possible_outbound_ip_addresses

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

possible_outbound_ip_addresses: str | None

public_network_access

'Enabled', 'Disabled' or an empty string.

public_network_access: str | None

redundancy_mode

"None", "Manual", "Failover", "ActiveActive", and "GeoRedundant".

redundancy_mode: str | _models.RedundancyMode | None

repository_site_name

Name of the repository site.

repository_site_name: str | None

reserved

true if reserved; otherwise, false.

reserved: bool | None

resource_config

Function app resource requirements.

resource_config: _models.ResourceConfig | None

resource_group

Name of the resource group the app belongs to. Read-only.

resource_group: str | None

scm_site_also_stopped

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

scm_site_also_stopped: bool | None

server_farm_id

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

server_farm_id: str | None

site_config

Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information.

site_config: _models.SiteConfig | None

sku

Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2.

sku: str | None

slot_swap_status

Status of the last deployment slot swap operation.

slot_swap_status: _models.SlotSwapStatus | None

ssh_enabled

Whether to enable ssh access.

ssh_enabled: bool | None

state

Current state of the app.

state: str | None

storage_account_required

Checks if Customer provided storage account is required.

storage_account_required: bool | None

suspended_till

App suspended till in case memory-time quota is exceeded.

suspended_till: datetime | None

target_swap_slot

Specifies which deployment slot this app will swap into. Read-only.

target_swap_slot: str | None

traffic_manager_host_names

Azure Traffic Manager hostnames associated with the app. Read-only.

traffic_manager_host_names: list[str] | None

usage_state

State indicating whether the app has exceeded its quota usage. Read-only. Known values are: "Normal" and "Exceeded".

usage_state: str | _models.UsageState | None

virtual_network_subnet_id

Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.

virtual_network_subnet_id: str | None

workload_profile_name

Workload profile name for function app to execute on.

workload_profile_name: str | None