SitePatchResource Class

ARM resource for a site.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.web.v2023_01_01.models._models_py3.ProxyOnlyResource

SitePatchResource

Constructor

SitePatchResource(*, kind: str | None = None, identity: _models.ManagedServiceIdentity | None = None, enabled: bool | None = None, host_name_ssl_states: List[_models.HostNameSslState] | None = None, server_farm_id: str | None = None, reserved: bool = False, is_xenon: bool = False, hyper_v: bool = False, site_config: _models.SiteConfig | None = None, scm_site_also_stopped: bool = False, hosting_environment_profile: _models.HostingEnvironmentProfile | None = None, client_affinity_enabled: bool | None = None, client_cert_enabled: bool | None = None, client_cert_mode: str | _models.ClientCertMode | None = None, client_cert_exclusion_paths: str | None = None, host_names_disabled: bool | None = None, custom_domain_verification_id: str | None = None, container_size: int | None = None, daily_memory_time_quota: int | None = None, cloning_info: _models.CloningInfo | None = None, https_only: bool | None = None, redundancy_mode: str | _models.RedundancyMode | None = None, storage_account_required: bool | None = None, key_vault_reference_identity: str | None = None, virtual_network_subnet_id: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
kind	str Kind of resource.
identity	ManagedServiceIdentity Managed service identity.
enabled	bool <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).
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}". # pylint: disable=line-too-long
reserved	bool <code>true</code> if reserved; otherwise, <code>false</code>.
is_xenon	bool Obsolete: Hyper-V sandbox.
hyper_v	bool Hyper-V sandbox.
site_config	SiteConfig Configuration of the app.
scm_site_also_stopped	bool <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.
hosting_environment_profile	HostingEnvironmentProfile App Service Environment to use for the app.
client_affinity_enabled	bool <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.
client_cert_enabled	bool <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.
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.
host_names_disabled	bool <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, 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.
container_size	int Size of the function container.
daily_memory_time_quota	int Maximum allowed daily memory-time quota (applicable on dynamic apps only).
cloning_info	CloningInfo If specified during app creation, the app is cloned from a source app.
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".
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.
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}. # pylint: disable=line-too-long

Variables

Name	Description
id	str Resource Id.
name	str Resource Name.
kind	str Kind of resource.
type	str Resource type.
identity	ManagedServiceIdentity Managed service identity.
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 <code>true</code> if the app is enabled; otherwise, <code>false</code>. 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}". # pylint: disable=line-too-long
reserved	bool <code>true</code> if reserved; otherwise, <code>false</code>.
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.
site_config	SiteConfig Configuration of the app.
traffic_manager_host_names	list[str] Azure Traffic Manager hostnames associated with the app. Read-only.
scm_site_also_stopped	bool <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.
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 <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.
client_cert_enabled	bool <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.
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.
host_names_disabled	bool <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, 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 <code>true</code> if the app is a default container; otherwise, <code>false</code>.
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.
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.
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}. # pylint: disable=line-too-long