你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Site 类

Web 应用、移动应用后端或 API 应用。

变量仅由服务器填充,发送请求时将被忽略。

必须填充所有必需的参数才能发送到 Azure。

继承
azure.mgmt.web.v2023_01_01.models._models_py3.Resource
Site

构造函数

Site(*, location: str, kind: str | None = None, tags: Dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, extended_location: _models.ExtendedLocation | 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, vnet_route_all_enabled: bool | None = None, vnet_image_pull_enabled: bool | None = None, vnet_content_share_enabled: bool | None = None, site_config: _models.SiteConfig | None = None, dapr_config: _models.DaprConfig | None = None, workload_profile_name: str | None = None, resource_config: _models.ResourceConfig | 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, public_network_access: str | None = None, storage_account_required: bool | None = None, key_vault_reference_identity: str | None = None, virtual_network_subnet_id: str | None = None, managed_environment_id: str | None = None, **kwargs: Any)

仅限关键字的参数

名称 说明
kind
str

资源类型。

location
str

资源位置。 必需。

tags

资源标记。

identity

托管服务标识。

extended_location

扩展位置。

enabled

<code>true</code> 如果应用已启用,则为 ;否则为 <code>false</code>。 将此值设置为 false 会禁用应用 (使应用脱机) 。

host_name_ssl_states

主机名 SSL 状态用于管理应用主机名的 SSL 绑定。

server_farm_id
str

关联的App 服务计划的资源 ID,格式为:“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。

reserved

<code>true</code> 如果保留,则为 ;否则为 <code>false</code>

is_xenon

已过时:Hyper-V 沙盒。

hyper_v

Hyper-V 沙盒。

vnet_route_all_enabled

虚拟网络“全部路由”已启用。 这会导致所有出站流量都应用虚拟网络安全组和用户定义的路由。

vnet_image_pull_enabled

启用通过虚拟网络拉取映像。

vnet_content_share_enabled

启用通过虚拟网络访问内容。

site_config

应用的配置。

dapr_config

应用的 Dapr 配置。

workload_profile_name
str

要在其中执行的函数应用的工作负荷配置文件名称。

resource_config

函数应用资源要求。

scm_site_also_stopped

<code>true</code> 在停止应用时停止 SCM (KUDU) 站点;否则为 <code>false</code>。 默认为 <code>false</code>

hosting_environment_profile

要用于应用的应用服务环境。

client_affinity_enabled

<code>true</code> 若要启用客户端关联,则为 ; <code>false</code> 停止发送会话相关性 Cookie,将同一会话中的客户端请求路由到同一实例。 默认为 <code>true</code>

client_cert_enabled

<code>true</code> 启用客户端证书身份验证 (TLS 相互身份验证) ;否则为 <code>false</code>。 默认为 <code>false</code>

client_cert_mode

这由 ClientCertEnabled 设置组成。

  • ClientCertEnabled:false 表示忽略 ClientCert。

  • ClientCertEnabled: true 和 ClientCertMode: Required 表示 ClientCert 是必需的。

  • ClientCertEnabled: true 和 ClientCertMode: Optional 表示 ClientCert 为可选或

接受。 已知值为:“Required”、“Optional”和“OptionalInteractiveUser”。

client_cert_exclusion_paths
str

客户端证书身份验证逗号分隔的排除路径。

host_names_disabled

<code>true</code> 禁用应用的公共主机名;否则为 <code>false</code>

如果 <code>true</code>为 ,则只能通过 API 管理过程访问应用。

custom_domain_verification_id
str

验证分配给应用的自定义域的唯一标识符。 客户将此 ID 添加到 txt 记录进行验证。

container_size
int

函数容器的大小。

daily_memory_time_quota
int

允许的最大每日内存时间配额 (仅适用于) 动态应用。

cloning_info

如果在创建应用期间指定,则会从源应用克隆该应用。

https_only

HttpsOnly:将网站配置为仅接受 https 请求。 http 请求的重定向问题。

redundancy_mode

站点冗余模式。 已知值为:“None”、“Manual”、“Failover”、“ActiveActive”和“GeoRedundant”。

public_network_access
str

允许或阻止所有公共流量的属性。 允许的值:“Enabled”、“Disabled”或空字符串。

storage_account_required

检查是否需要客户提供的存储帐户。

key_vault_reference_identity
str

用于密钥保管库参考身份验证的标识。

virtual_network_subnet_id
str

Azure 资源管理器区域 VNET 集成要加入的虚拟网络和子网的 ID。 此格式必须为 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}。

managed_environment_id
str

Azure 资源管理器托管此应用的客户的所选托管环境的 ID。 此格式必须为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}。

变量

名称 说明
id
str

资源 ID。

name
str

资源名称。

kind
str

资源类型。

location
str

资源位置。 必需。

type
str

资源类型。

tags

资源标记。

identity

托管服务标识。

extended_location

扩展位置。

state
str

应用的当前状态。

host_names

与应用关联的主机名。

repository_site_name
str

存储库站点的名称。

usage_state

指示应用是否已超出其配额使用量的状态。 只读。 已知值为:“Normal”和“Exceeded”。

enabled

<code>true</code> 如果应用已启用,则为 ;否则为 <code>false</code>。 将此值设置为 false 会禁用应用 (使应用脱机) 。

enabled_host_names

为应用启用了主机名。需要分配主机名 (请参阅 hostNames) and enabled。 否则,不会在这些主机名上提供应用。

availability_state

应用的管理信息可用性状态。 已知值为:“Normal”、“Limited”和“DisasterRecoveryMode”。

host_name_ssl_states

主机名 SSL 状态用于管理应用主机名的 SSL 绑定。

server_farm_id
str

关联的App 服务计划的资源 ID,格式为:“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。

reserved

<code>true</code> 如果保留,则为 ;否则为 <code>false</code>

is_xenon

已过时:Hyper-V 沙盒。

hyper_v

Hyper-V 沙盒。

last_modified_time_utc

上次修改应用的时间(UTC)。 只读。

vnet_route_all_enabled

虚拟网络“全部路由”已启用。 这会导致所有出站流量都应用虚拟网络安全组和用户定义的路由。

vnet_image_pull_enabled

启用通过虚拟网络拉取映像。

vnet_content_share_enabled

启用通过虚拟网络访问内容。

site_config

应用的配置。

dapr_config

应用的 Dapr 配置。

workload_profile_name
str

要在其中执行的函数应用的工作负荷配置文件名称。

resource_config

函数应用资源要求。

traffic_manager_host_names

与应用关联的 Azure 流量管理器主机名。 只读。

scm_site_also_stopped

<code>true</code> 在停止应用时停止 SCM (KUDU) 站点;否则为 <code>false</code>。 默认为 <code>false</code>

target_swap_slot
str

指定此应用将交换到哪个部署槽位。 只读。

hosting_environment_profile

要用于应用的应用服务环境。

client_affinity_enabled

<code>true</code> 若要启用客户端关联,则为 ; <code>false</code> 停止发送会话相关性 Cookie,将同一会话中的客户端请求路由到同一实例。 默认为 <code>true</code>

client_cert_enabled

<code>true</code> 启用客户端证书身份验证 (TLS 相互身份验证) ;否则为 <code>false</code>。 默认为 <code>false</code>

client_cert_mode

这由 ClientCertEnabled 设置组成。

  • ClientCertEnabled:false 表示忽略 ClientCert。

  • ClientCertEnabled: true 和 ClientCertMode: Required 表示 ClientCert 是必需的。

  • ClientCertEnabled: true 和 ClientCertMode: Optional 表示 ClientCert 为可选或

接受。 已知值为:“Required”、“Optional”和“OptionalInteractiveUser”。

client_cert_exclusion_paths
str

客户端证书身份验证逗号分隔的排除路径。

host_names_disabled

<code>true</code> 禁用应用的公共主机名;否则为 <code>false</code>

如果 <code>true</code>为 ,则只能通过 API 管理过程访问应用。

custom_domain_verification_id
str

验证分配给应用的自定义域的唯一标识符。 客户将此 ID 添加到 txt 记录进行验证。

outbound_ip_addresses
str

应用用于出站连接的 IP 地址列表 (例如数据库访问) 。 包括可以使用当前设置托管站点的租户中的 VIP。 只读。

possible_outbound_ip_addresses
str

应用用于出站连接的 IP 地址列表 (例如数据库访问) 。 包括除 dataComponent 以外的所有租户的 VIP。 只读。

container_size
int

函数容器的大小。

daily_memory_time_quota
int

允许的最大每日内存时间配额 (仅适用于) 动态应用。

suspended_till

应用暂停,直到超过内存时间配额。

max_number_of_workers
int

最大辅助角色数。 这仅适用于 Functions 容器。

cloning_info

如果在创建应用期间指定,则会从源应用克隆该应用。

resource_group
str

应用所属的资源组的名称。 只读。

is_default_container

<code>true</code> 如果应用是默认容器,则为 ;否则为 <code>false</code>

default_host_name
str

应用的默认主机名。 只读。

slot_swap_status

上次部署槽交换操作的状态。

https_only

HttpsOnly:将网站配置为仅接受 https 请求。 http 请求的重定向问题。

redundancy_mode

站点冗余模式。 已知值为:“None”、“Manual”、“Failover”、“ActiveActive”和“GeoRedundant”。

in_progress_operation_id
str

如果此站点有挂起的操作,则指定操作 ID。

public_network_access
str

允许或阻止所有公共流量的属性。 允许的值:“Enabled”、“Disabled”或空字符串。

storage_account_required

检查是否需要客户提供的存储帐户。

key_vault_reference_identity
str

用于密钥保管库参考身份验证的标识。

virtual_network_subnet_id
str

Azure 资源管理器区域 VNET 集成要加入的虚拟网络和子网的 ID。 此格式必须为 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}。

managed_environment_id
str

Azure 资源管理器托管此应用的客户的所选托管环境的 ID。 此格式必须为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}。