azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations
name: StaticSitesOperations
fullName: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations
module: azure.mgmt.web.v2020_09_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.web.v2020_09_01.WebSiteManagementClient>'s\n\
  >\n> <xref:static_sites> attribute.\n>"
constructor:
  syntax: StaticSitesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.create_or_update_static_site
  name: create_or_update_static_site
  summary: 'Creates a new static site in an existing resource group, or updates an
    existing static site.


    Creates a new static site in an existing resource group, or updates an existing
    static site.'
  signature: 'create_or_update_static_site(resource_group_name: str, name: str, static_site_envelope:
    _models.StaticSiteARMResource, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.StaticSiteARMResource'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site to create or update. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: static_site_envelope
    description: 'A JSON representation of the staticsite properties. See example.

      Is either a StaticSiteARMResource type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteARMResource>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSiteARMResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteARMResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.create_or_update_static_site_build_function_app_settings
  name: create_or_update_static_site_build_function_app_settings
  summary: 'Creates or updates the function app settings of a static site build.


    Creates or updates the function app settings of a static site build.'
  signature: 'create_or_update_static_site_build_function_app_settings(resource_group_name:
    str, name: str, pr_id: str, app_settings: _models.StringDictionary, *, content_type:
    str = ''application/json'', **kwargs: Any) -> _models.StringDictionary'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: pr_id
    description: The stage site identifier. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: app_settings
    description: Is either a StringDictionary type or a IO type. Required.
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StringDictionary>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StringDictionary or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StringDictionary>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.create_or_update_static_site_custom_domain
  name: create_or_update_static_site_custom_domain
  summary: 'Creates a new static site custom domain in an existing resource group
    and static site.


    Creates a new static site custom domain in an existing resource group and static
    site.'
  signature: 'create_or_update_static_site_custom_domain(resource_group_name: str,
    name: str, domain_name: str, **kwargs: Any) -> StaticSiteCustomDomainOverviewARMResource'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: domain_name
    description: The custom domain to create. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSiteCustomDomainOverviewARMResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteCustomDomainOverviewARMResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.create_or_update_static_site_function_app_settings
  name: create_or_update_static_site_function_app_settings
  summary: 'Creates or updates the function app settings of a static site.


    Creates or updates the function app settings of a static site.'
  signature: 'create_or_update_static_site_function_app_settings(resource_group_name:
    str, name: str, app_settings: _models.StringDictionary, *, content_type: str =
    ''application/json'', **kwargs: Any) -> _models.StringDictionary'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: app_settings
    description: Is either a StringDictionary type or a IO type. Required.
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StringDictionary>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StringDictionary or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StringDictionary>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.create_user_roles_invitation_link
  name: create_user_roles_invitation_link
  summary: 'Creates an invitation link for a user with the role.


    Creates an invitation link for a user with the role.'
  signature: 'create_user_roles_invitation_link(resource_group_name: str, name: str,
    static_site_user_roles_invitation_envelope: _models.StaticSiteUserInvitationRequestResource,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.StaticSiteUserInvitationResponseResource'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: static_site_user_roles_invitation_envelope
    description: 'Is either a

      StaticSiteUserInvitationRequestResource type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteUserInvitationRequestResource>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSiteUserInvitationResponseResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteUserInvitationResponseResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.delete_static_site
  name: delete_static_site
  summary: 'Deletes a static site.


    Deletes a static site.'
  signature: 'delete_static_site(resource_group_name: str, name: str, **kwargs: Any)
    -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.delete_static_site_build
  name: delete_static_site_build
  summary: 'Deletes a static site build.


    Deletes a static site build.'
  signature: 'delete_static_site_build(resource_group_name: str, name: str, pr_id:
    str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: pr_id
    description: The stage site identifier. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.delete_static_site_custom_domain
  name: delete_static_site_custom_domain
  summary: 'Deletes a custom domain.


    Deletes a custom domain.'
  signature: 'delete_static_site_custom_domain(resource_group_name: str, name: str,
    domain_name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: domain_name
    description: The custom domain to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.delete_static_site_user
  name: delete_static_site_user
  summary: 'Deletes the user entry from the static site.


    Deletes the user entry from the static site.'
  signature: 'delete_static_site_user(resource_group_name: str, name: str, authprovider:
    str, userid: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the staticsite. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authprovider
    description: The auth provider for this user. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: userid
    description: The user id of the user. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.detach_static_site
  name: detach_static_site
  summary: 'Detaches a static site.


    Detaches a static site.'
  signature: 'detach_static_site(resource_group_name: str, name: str, **kwargs: Any)
    -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site to detach. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.get_static_site
  name: get_static_site
  summary: 'Gets the details of a static site.


    Gets the details of a static site.'
  signature: 'get_static_site(resource_group_name: str, name: str, **kwargs: Any)
    -> StaticSiteARMResource'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSiteARMResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteARMResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.get_static_site_build
  name: get_static_site_build
  summary: 'Gets the details of a static site build.


    Gets the details of a static site build.'
  signature: 'get_static_site_build(resource_group_name: str, name: str, pr_id: str,
    **kwargs: Any) -> StaticSiteBuildARMResource'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: pr_id
    description: The stage site identifier. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSiteBuildARMResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteBuildARMResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.get_static_site_builds
  name: get_static_site_builds
  summary: 'Gets all static site builds for a particular static site.


    Gets all static site builds for a particular static site.'
  signature: 'get_static_site_builds(resource_group_name: str, name: str, **kwargs:
    Any) -> Iterable[StaticSiteBuildARMResource]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either StaticSiteBuildARMResource or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2020_09_01.models.StaticSiteBuildARMResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.get_static_sites_by_resource_group
  name: get_static_sites_by_resource_group
  summary: 'Gets all static sites in the specified resource group.


    Gets all static sites in the specified resource group.'
  signature: 'get_static_sites_by_resource_group(resource_group_name: str, **kwargs:
    Any) -> Iterable[StaticSiteARMResource]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either StaticSiteARMResource or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2020_09_01.models.StaticSiteARMResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list
  name: list
  summary: 'Get all Static Sites for a subscription.


    Get all Static Sites for a subscription.'
  signature: 'list(**kwargs: Any) -> Iterable[StaticSiteARMResource]'
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either StaticSiteARMResource or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2020_09_01.models.StaticSiteARMResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list_static_site_build_function_app_settings
  name: list_static_site_build_function_app_settings
  summary: 'Gets the application settings of a static site.


    Gets the application settings of a static site.'
  signature: 'list_static_site_build_function_app_settings(resource_group_name: str,
    name: str, pr_id: str, **kwargs: Any) -> StringDictionary'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: pr_id
    description: The stage site identifier. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StringDictionary or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StringDictionary>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list_static_site_build_functions
  name: list_static_site_build_functions
  summary: 'Gets the functions of a particular static site build.


    Gets the functions of a particular static site build.'
  signature: 'list_static_site_build_functions(resource_group_name: str, name: str,
    pr_id: str, **kwargs: Any) -> Iterable[StaticSiteFunctionOverviewARMResource]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: pr_id
    description: The stage site identifier. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either StaticSiteFunctionOverviewARMResource
      or the

      result of cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2020_09_01.models.StaticSiteFunctionOverviewARMResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list_static_site_custom_domains
  name: list_static_site_custom_domains
  summary: 'Gets all static site custom domains for a particular static site.


    Gets all static site custom domains for a particular static site.'
  signature: 'list_static_site_custom_domains(resource_group_name: str, name: str,
    **kwargs: Any) -> Iterable[StaticSiteCustomDomainOverviewARMResource]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site resource to search in. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either StaticSiteCustomDomainOverviewARMResource
      or the

      result of cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2020_09_01.models.StaticSiteCustomDomainOverviewARMResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list_static_site_function_app_settings
  name: list_static_site_function_app_settings
  summary: 'Gets the application settings of a static site.


    Gets the application settings of a static site.'
  signature: 'list_static_site_function_app_settings(resource_group_name: str, name:
    str, **kwargs: Any) -> StringDictionary'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StringDictionary or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StringDictionary>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list_static_site_functions
  name: list_static_site_functions
  summary: 'Gets the functions of a static site.


    Gets the functions of a static site.'
  signature: 'list_static_site_functions(resource_group_name: str, name: str, **kwargs:
    Any) -> Iterable[StaticSiteFunctionOverviewARMResource]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either StaticSiteFunctionOverviewARMResource
      or the

      result of cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2020_09_01.models.StaticSiteFunctionOverviewARMResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list_static_site_secrets
  name: list_static_site_secrets
  summary: 'Lists the secrets for an existing static site.


    Lists the secrets for an existing static site.'
  signature: 'list_static_site_secrets(resource_group_name: str, name: str, **kwargs:
    Any) -> StringDictionary'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StringDictionary or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StringDictionary>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.list_static_site_users
  name: list_static_site_users
  summary: 'Gets the list of users of a static site.


    Gets the list of users of a static site.'
  signature: 'list_static_site_users(resource_group_name: str, name: str, authprovider:
    str, **kwargs: Any) -> Iterable[StaticSiteUserARMResource]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authprovider
    description: The auth provider for the users. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either StaticSiteUserARMResource or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2020_09_01.models.StaticSiteUserARMResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.preview_workflow
  name: preview_workflow
  summary: 'Generates a preview workflow file for the static site.


    Generates a preview workflow file for the static site.'
  signature: 'preview_workflow(location: str, static_sites_workflow_preview_request:
    _models.StaticSitesWorkflowPreviewRequest, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.StaticSitesWorkflowPreview'
  parameters:
  - name: location
    description: Location where you plan to create the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: static_sites_workflow_preview_request
    description: 'A JSON representation of the

      StaticSitesWorkflowPreviewRequest properties. See example. Is either a

      StaticSitesWorkflowPreviewRequest type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSitesWorkflowPreviewRequest>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSitesWorkflowPreview or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSitesWorkflowPreview>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.reset_static_site_api_key
  name: reset_static_site_api_key
  summary: 'Resets the api key for an existing static site.


    Resets the api key for an existing static site.'
  signature: 'reset_static_site_api_key(resource_group_name: str, name: str, reset_properties_envelope:
    _models.StaticSiteResetPropertiesARMResource, *, content_type: str = ''application/json'',
    **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: reset_properties_envelope
    description: 'Is either a StaticSiteResetPropertiesARMResource type or a IO

      type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteResetPropertiesARMResource>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.update_static_site
  name: update_static_site
  summary: 'Creates a new static site in an existing resource group, or updates an
    existing static site.


    Creates a new static site in an existing resource group, or updates an existing
    static site.'
  signature: 'update_static_site(resource_group_name: str, name: str, static_site_envelope:
    _models.StaticSitePatchResource, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.StaticSiteARMResource'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site to create or update. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: static_site_envelope
    description: 'A JSON representation of the staticsite properties. See example.

      Is either a StaticSitePatchResource type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSitePatchResource>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSiteARMResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteARMResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.update_static_site_user
  name: update_static_site_user
  summary: 'Updates a user entry with the listed roles.


    Updates a user entry with the listed roles.'
  signature: 'update_static_site_user(resource_group_name: str, name: str, authprovider:
    str, userid: str, static_site_user_envelope: _models.StaticSiteUserARMResource,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.StaticSiteUserARMResource'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authprovider
    description: The auth provider for this user. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: userid
    description: The user id of the user. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: static_site_user_envelope
    description: 'A JSON representation of the StaticSiteUser properties. See

      example. Is either a StaticSiteUserARMResource type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteUserARMResource>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StaticSiteUserARMResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.StaticSiteUserARMResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.validate_custom_domain_can_be_added_to_static_site
  name: validate_custom_domain_can_be_added_to_static_site
  summary: 'Validates a particular custom domain can be added to a static site.


    Validates a particular custom domain can be added to a static site.'
  signature: 'validate_custom_domain_can_be_added_to_static_site(resource_group_name:
    str, name: str, domain_name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the static site. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: domain_name
    description: The custom domain to validate. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.web.v2020_09_01.operations.StaticSitesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.web.v2020_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2020_09_01\\models\\__init__.py'>