azure.mgmt.web.v2023_12_01.models.StaticSiteARMResource.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2023_12_01.models.StaticSiteARMResource
name: StaticSiteARMResource
fullName: azure.mgmt.web.v2023_12_01.models.StaticSiteARMResource
module: azure.mgmt.web.v2023_12_01.models
inheritances:
- azure.mgmt.web.v2023_12_01.models._models_py3.Resource
summary: 'Static Site ARM resource.


  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: 'StaticSiteARMResource(*, location: str, kind: str | None = None, tags:
    Dict[str, str] | None = None, sku: _models.SkuDescription | None = None, identity:
    _models.ManagedServiceIdentity | None = None, repository_url: str | None = None,
    branch: str | None = None, repository_token: str | None = None, build_properties:
    _models.StaticSiteBuildProperties | None = None, staging_environment_policy: str
    | _models.StagingEnvironmentPolicy | None = None, allow_config_file_updates: bool
    | None = None, template_properties: _models.StaticSiteTemplateOptions | None =
    None, provider: str | None = None, enterprise_grade_cdn_status: str | _models.EnterpriseGradeCdnStatus
    | None = None, public_network_access: 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: sku
    description: Description of a SKU for a scalable resource.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.SkuDescription>
  - name: identity
    description: Managed service identity.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.ManagedServiceIdentity>
  - name: repository_url
    description: URL for the repository of the static site.
    types:
    - <xref:str>
  - name: branch
    description: The target branch in the repository.
    types:
    - <xref:str>
  - name: repository_token
    description: 'A user''s github repository token. This is used to setup the Github

      Actions workflow file and API secrets.'
    types:
    - <xref:str>
  - name: build_properties
    description: Build properties to configure on the repository.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.StaticSiteBuildProperties>
  - name: staging_environment_policy
    description: 'State indicating whether staging environments are allowed

      or not allowed for a static web app. Known values are: "Enabled" and "Disabled".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.web.v2023_12_01.models.StagingEnvironmentPolicy>
  - name: allow_config_file_updates
    description: '`<code>false</code>` if config file is locked for

      this static web app; otherwise, `<code>true</code>`.'
    types:
    - <xref:bool>
  - name: template_properties
    description: Template options for generating a new repository.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.StaticSiteTemplateOptions>
  - name: provider
    description: 'The provider that submitted the last deployment to the primary environment

      of the static site.'
    types:
    - <xref:str>
  - name: enterprise_grade_cdn_status
    description: 'State indicating the status of the enterprise grade CDN

      serving traffic to the static web app. Known values are: "Enabled", "Enabling",
      "Disabled", and

      "Disabling".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.web.v2023_12_01.models.EnterpriseGradeCdnStatus>
  - name: public_network_access
    description: 'State indicating whether public traffic are allowed or not for

      a static web app. Allowed Values: ''Enabled'', ''Disabled'' or an empty string.'
    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: Description of a SKU for a scalable resource.
  name: sku
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.SkuDescription>
- description: Managed service identity.
  name: identity
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.ManagedServiceIdentity>
- description: The default autogenerated hostname for the static site.
  name: default_hostname
  types:
  - <xref:str>
- description: URL for the repository of the static site.
  name: repository_url
  types:
  - <xref:str>
- description: The target branch in the repository.
  name: branch
  types:
  - <xref:str>
- description: The custom domains associated with this static site.
  name: custom_domains
  types:
  - <xref:list>[<xref:str>]
- description: 'A user''s github repository token. This is used to setup the Github

    Actions workflow file and API secrets.'
  name: repository_token
  types:
  - <xref:str>
- description: Build properties to configure on the repository.
  name: build_properties
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.StaticSiteBuildProperties>
- description: Private endpoint connections.
  name: private_endpoint_connections
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2023_12_01.models.ResponseMessageEnvelopeRemotePrivateEndpointConnection>]
- description: 'State indicating whether staging environments are allowed or

    not allowed for a static web app. Known values are: "Enabled" and "Disabled".'
  name: staging_environment_policy
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.StagingEnvironmentPolicy>
- description: '`<code>false</code>` if config file is locked for this

    static web app; otherwise, `<code>true</code>`.'
  name: allow_config_file_updates
  types:
  - <xref:bool>
- description: Template options for generating a new repository.
  name: template_properties
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.StaticSiteTemplateOptions>
- description: The content distribution endpoint for the static site.
  name: content_distribution_endpoint
  types:
  - <xref:str>
- description: Identity to use for Key Vault Reference authentication.
  name: key_vault_reference_identity
  types:
  - <xref:str>
- description: User provided function apps registered with the static site.
  name: user_provided_function_apps
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2023_12_01.models.StaticSiteUserProvidedFunctionApp>]
- description: Backends linked to the static side.
  name: linked_backends
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2023_12_01.models.StaticSiteLinkedBackend>]
- description: 'The provider that submitted the last deployment to the primary environment
    of

    the static site.'
  name: provider
  types:
  - <xref:str>
- description: 'State indicating the status of the enterprise grade CDN

    serving traffic to the static web app. Known values are: "Enabled", "Enabling",
    "Disabled", and

    "Disabling".'
  name: enterprise_grade_cdn_status
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.EnterpriseGradeCdnStatus>
- description: 'State indicating whether public traffic are allowed or not for a

    static web app. Allowed Values: ''Enabled'', ''Disabled'' or an empty string.'
  name: public_network_access
  types:
  - <xref:str>
- description: Database connections for the static site.
  name: database_connections
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2023_12_01.models.DatabaseConnectionOverview>]