azure.mgmt.web.v2021_03_01.models.Site.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2021_03_01.models.Site
name: Site
fullName: azure.mgmt.web.v2021_03_01.models.Site
module: azure.mgmt.web.v2021_03_01.models
inheritances:
- azure.mgmt.web.v2021_03_01.models._models_py3.Resource
summary: 'A web app, a mobile app backend, or an API app.


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


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: '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, 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)'
  keywordOnlyParameters:
  - name: kind
    description: Kind of resource.
    types:
    - <xref:str>
  - name: location
    description: Resource Location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: identity
    description: Managed service identity.
    types:
    - <xref:azure.mgmt.web.v2021_03_01.models.ManagedServiceIdentity>
  - name: extended_location
    description: Extended Location.
    types:
    - <xref:azure.mgmt.web.v2021_03_01.models.ExtendedLocation>
  - name: enabled
    description: '`<code>true</code>` if the app is enabled; otherwise,

      `<code>false</code>`. Setting this value to false disables the app (takes the
      app

      offline).'
    types:
    - <xref:bool>
  - name: host_name_ssl_states
    description: 'Hostname SSL states are used to manage the SSL bindings for

      app''s hostnames.'
    types:
    - <xref:list>[<xref:azure.mgmt.web.v2021_03_01.models.HostNameSslState>]
  - name: server_farm_id
    description: 'Resource ID of the associated App Service plan, formatted as:

      "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".  #
      pylint: disable=line-too-long'
    types:
    - <xref:str>
  - name: reserved
    description: '`<code>true</code>` if reserved; otherwise,

      `<code>false</code>`.'
    types:
    - <xref:bool>
  - name: is_xenon
    description: 'Obsolete: Hyper-V sandbox.'
    types:
    - <xref:bool>
  - name: hyper_v
    description: Hyper-V sandbox.
    types:
    - <xref:bool>
  - name: site_config
    description: Configuration of the app.
    types:
    - <xref:azure.mgmt.web.v2021_03_01.models.SiteConfig>
  - name: scm_site_also_stopped
    description: '`<code>true</code>` to stop SCM (KUDU) site when the app

      is stopped; otherwise, `<code>false</code>`. The default is `<code>false</code>`.'
    types:
    - <xref:bool>
  - name: hosting_environment_profile
    description: App Service Environment to use for the app.
    types:
    - <xref:azure.mgmt.web.v2021_03_01.models.HostingEnvironmentProfile>
  - name: client_affinity_enabled
    description: '`<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>`.'
    types:
    - <xref:bool>
  - name: client_cert_enabled
    description: '`<code>true</code>` to enable client certificate

      authentication (TLS mutual authentication); otherwise, `<code>false</code>`.
      Default is

      `<code>false</code>`.'
    types:
    - <xref:bool>
  - name: client_cert_mode
    description: "This composes with ClientCertEnabled setting.\n\n* ClientCertEnabled:\
      \ false means ClientCert is ignored. \n\n* ClientCertEnabled: true and ClientCertMode:\
      \ Required means ClientCert is required. \n\n* ClientCertEnabled: true and ClientCertMode:\
      \ Optional means ClientCert is optional or \n\naccepted. Known values are: \"\
      Required\", \"Optional\", and \"OptionalInteractiveUser\"."
    types:
    - <xref:str>
    - <xref:azure.mgmt.web.v2021_03_01.models.ClientCertMode>
  - name: client_cert_exclusion_paths
    description: 'client certificate authentication comma-separated

      exclusion paths.'
    types:
    - <xref:str>
  - name: host_names_disabled
    description: "`<code>true</code>` to disable the public hostnames of the\napp;\
      \ otherwise, `<code>false</code>`.\n\n   If `<code>true</code>`, the app is\
      \ only accessible via API management process."
    types:
    - <xref:bool>
  - name: custom_domain_verification_id
    description: 'Unique identifier that verifies the custom domains

      assigned to the app. Customer will add this id to a txt record for verification.'
    types:
    - <xref:str>
  - name: container_size
    description: Size of the function container.
    types:
    - <xref:int>
  - name: daily_memory_time_quota
    description: 'Maximum allowed daily memory-time quota (applicable on

      dynamic apps only).'
    types:
    - <xref:int>
  - name: cloning_info
    description: If specified during app creation, the app is cloned from a source
      app.
    types:
    - <xref:azure.mgmt.web.v2021_03_01.models.CloningInfo>
  - name: https_only
    description: 'HttpsOnly: configures a web site to accept only https requests.
      Issues

      redirect for

      http requests.'
    types:
    - <xref:bool>
  - name: redundancy_mode
    description: 'Site redundancy mode. Known values are: "None", "Manual", "Failover",

      "ActiveActive", and "GeoRedundant".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.web.v2021_03_01.models.RedundancyMode>
  - name: storage_account_required
    description: Checks if Customer provided storage account is required.
    types:
    - <xref:bool>
  - name: key_vault_reference_identity
    description: Identity to use for Key Vault Reference authentication.
    types:
    - <xref:str>
  - name: virtual_network_subnet_id
    description: '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'
    types:
    - <xref:str>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource Name.
  name: name
  types:
  - <xref:str>
- description: Kind of resource.
  name: kind
  types:
  - <xref:str>
- description: Resource Location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: Managed service identity.
  name: identity
  types:
  - <xref:azure.mgmt.web.v2021_03_01.models.ManagedServiceIdentity>
- description: Extended Location.
  name: extended_location
  types:
  - <xref:azure.mgmt.web.v2021_03_01.models.ExtendedLocation>
- description: Current state of the app.
  name: state
  types:
  - <xref:str>
- description: Hostnames associated with the app.
  name: host_names
  types:
  - <xref:list>[<xref:str>]
- description: Name of the repository site.
  name: repository_site_name
  types:
  - <xref:str>
- description: 'State indicating whether the app has exceeded its quota usage. Read-only.

    Known values are: "Normal" and "Exceeded".'
  name: usage_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2021_03_01.models.UsageState>
- description: '`<code>true</code>` if the app is enabled; otherwise,

    `<code>false</code>`. Setting this value to false disables the app (takes the
    app

    offline).'
  name: enabled
  types:
  - <xref:bool>
- description: 'Enabled hostnames for the app.Hostnames need to be assigned (see

    HostNames) AND enabled. Otherwise,

    the app is not served on those hostnames.'
  name: enabled_host_names
  types:
  - <xref:list>[<xref:str>]
- description: 'Management information availability state for the app. Known values

    are: "Normal", "Limited", and "DisasterRecoveryMode".'
  name: availability_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2021_03_01.models.SiteAvailabilityState>
- description: 'Hostname SSL states are used to manage the SSL bindings for app''s

    hostnames.'
  name: host_name_ssl_states
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2021_03_01.models.HostNameSslState>]
- description: 'Resource ID of the associated App Service plan, formatted as:

    "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".  #
    pylint: disable=line-too-long'
  name: server_farm_id
  types:
  - <xref:str>
- description: '`<code>true</code>` if reserved; otherwise, `<code>false</code>`.'
  name: reserved
  types:
  - <xref:bool>
- description: 'Obsolete: Hyper-V sandbox.'
  name: is_xenon
  types:
  - <xref:bool>
- description: Hyper-V sandbox.
  name: hyper_v
  types:
  - <xref:bool>
- description: Last time the app was modified, in UTC. Read-only.
  name: last_modified_time_utc
  types:
  - <xref:datetime.datetime>
- description: Configuration of the app.
  name: site_config
  types:
  - <xref:azure.mgmt.web.v2021_03_01.models.SiteConfig>
- description: 'Azure Traffic Manager hostnames associated with the app.

    Read-only.'
  name: traffic_manager_host_names
  types:
  - <xref:list>[<xref:str>]
- description: '`<code>true</code>` to stop SCM (KUDU) site when the app is

    stopped; otherwise, `<code>false</code>`. The default is `<code>false</code>`.'
  name: scm_site_also_stopped
  types:
  - <xref:bool>
- description: Specifies which deployment slot this app will swap into. Read-only.
  name: target_swap_slot
  types:
  - <xref:str>
- description: App Service Environment to use for the app.
  name: hosting_environment_profile
  types:
  - <xref:azure.mgmt.web.v2021_03_01.models.HostingEnvironmentProfile>
- description: '`<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>`.'
  name: client_affinity_enabled
  types:
  - <xref:bool>
- description: '`<code>true</code>` to enable client certificate

    authentication (TLS mutual authentication); otherwise, `<code>false</code>`. Default
    is

    `<code>false</code>`.'
  name: client_cert_enabled
  types:
  - <xref:bool>
- description: "This composes with ClientCertEnabled setting.\n\n* ClientCertEnabled:\
    \ false means ClientCert is ignored. \n\n* ClientCertEnabled: true and ClientCertMode:\
    \ Required means ClientCert is required. \n\n* ClientCertEnabled: true and ClientCertMode:\
    \ Optional means ClientCert is optional or \n\naccepted. Known values are: \"\
    Required\", \"Optional\", and \"OptionalInteractiveUser\"."
  name: client_cert_mode
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2021_03_01.models.ClientCertMode>
- description: 'client certificate authentication comma-separated exclusion

    paths.'
  name: client_cert_exclusion_paths
  types:
  - <xref:str>
- description: "`<code>true</code>` to disable the public hostnames of the\napp; otherwise,\
    \ `<code>false</code>`.\n\n   If `<code>true</code>`, the app is only accessible\
    \ via API management process."
  name: host_names_disabled
  types:
  - <xref:bool>
- description: 'Unique identifier that verifies the custom domains

    assigned to the app. Customer will add this id to a txt record for verification.'
  name: custom_domain_verification_id
  types:
  - <xref:str>
- description: '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.'
  name: outbound_ip_addresses
  types:
  - <xref:str>
- description: 'List of IP addresses that the app uses for outbound

    connections (e.g. database access). Includes VIPs from all tenants except dataComponent.

    Read-only.'
  name: possible_outbound_ip_addresses
  types:
  - <xref:str>
- description: Size of the function container.
  name: container_size
  types:
  - <xref:int>
- description: 'Maximum allowed daily memory-time quota (applicable on dynamic

    apps only).'
  name: daily_memory_time_quota
  types:
  - <xref:int>
- description: App suspended till in case memory-time quota is exceeded.
  name: suspended_till
  types:
  - <xref:datetime.datetime>
- description: 'Maximum number of workers.

    This only applies to Functions container.'
  name: max_number_of_workers
  types:
  - <xref:int>
- description: If specified during app creation, the app is cloned from a source app.
  name: cloning_info
  types:
  - <xref:azure.mgmt.web.v2021_03_01.models.CloningInfo>
- description: Name of the resource group the app belongs to. Read-only.
  name: resource_group
  types:
  - <xref:str>
- description: '`<code>true</code>` if the app is a default container;

    otherwise, `<code>false</code>`.'
  name: is_default_container
  types:
  - <xref:bool>
- description: Default hostname of the app. Read-only.
  name: default_host_name
  types:
  - <xref:str>
- description: Status of the last deployment slot swap operation.
  name: slot_swap_status
  types:
  - <xref:azure.mgmt.web.v2021_03_01.models.SlotSwapStatus>
- description: 'HttpsOnly: configures a web site to accept only https requests. Issues

    redirect for

    http requests.'
  name: https_only
  types:
  - <xref:bool>
- description: 'Site redundancy mode. Known values are: "None", "Manual", "Failover",

    "ActiveActive", and "GeoRedundant".'
  name: redundancy_mode
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2021_03_01.models.RedundancyMode>
- description: Specifies an operation id if this site has a pending operation.
  name: in_progress_operation_id
  types:
  - <xref:str>
- description: Checks if Customer provided storage account is required.
  name: storage_account_required
  types:
  - <xref:bool>
- description: Identity to use for Key Vault Reference authentication.
  name: key_vault_reference_identity
  types:
  - <xref:str>
- description: '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'
  name: virtual_network_subnet_id
  types:
  - <xref:str>