StaticSitesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:static_sites> attribute.

Inheritance

builtins.object

StaticSitesOperations

Constructor

StaticSitesOperations(*args, **kwargs)

Methods

begin_approve_or_reject_private_endpoint_connection	Approves or rejects a private endpoint connection. Description for Approves or rejects a private endpoint connection.
begin_create_or_update_static_site	Creates a new static site in an existing resource group, or updates an existing static site. Description for Creates a new static site in an existing resource group, or updates an existing static site.
begin_create_or_update_static_site_custom_domain	Creates a new static site custom domain in an existing resource group and static site. Description for Creates a new static site custom domain in an existing resource group and static site.
begin_create_zip_deployment_for_static_site	Deploys zipped content to a static site. Description for Deploys zipped content to a static site.
begin_create_zip_deployment_for_static_site_build	Deploys zipped content to a specific environment of a static site. Description for Deploys zipped content to a specific environment of a static site.
begin_delete_private_endpoint_connection	Deletes a private endpoint connection. Description for Deletes a private endpoint connection.
begin_delete_static_site	Deletes a static site. Description for Deletes a static site.
begin_delete_static_site_build	Deletes a static site build. Description for Deletes a static site build.
begin_delete_static_site_custom_domain	Deletes a custom domain. Description for Deletes a custom domain.
begin_detach_static_site	Detaches a static site. Description for Detaches a static site.
begin_link_backend	Link backend to a static site. Link backend to a static site.
begin_link_backend_to_build	Link backend to a static site build. Link backend to a static site build.
begin_register_user_provided_function_app_with_static_site	Register a user provided function app with a static site. Description for Register a user provided function app with a static site.
begin_register_user_provided_function_app_with_static_site_build	Register a user provided function app with a static site build. Description for Register a user provided function app with a static site build.
begin_validate_backend	Validates that a backend can be linked to a static site. Validates that a backend can be linked to a static site.
begin_validate_backend_for_build	Validates that a backend can be linked to a static site build. Validates that a backend can be linked to a static site build.
begin_validate_custom_domain_can_be_added_to_static_site	Validates a particular custom domain can be added to a static site. Description for Validates a particular custom domain can be added to a static site.
create_or_update_basic_auth	Adds or updates basic auth for a static site. Description for Adds or updates basic auth for a static site.
create_or_update_build_database_connection	Create or update a database connection for a static site build. Description for Create or update a database connection for a static site build.
create_or_update_database_connection	Create or update a database connection for a static site. Description for Create or update a database connection for a static site.
create_or_update_static_site_app_settings	Creates or updates the app settings of a static site. Description for Creates or updates the app settings of a static site.
create_or_update_static_site_build_app_settings	Creates or updates the app settings of a static site build. Description for Creates or updates the app settings of a static site build.
create_or_update_static_site_build_function_app_settings	Creates or updates the function app settings of a static site build. Description for Creates or updates the function app settings of a static site build.
create_or_update_static_site_function_app_settings	Creates or updates the function app settings of a static site. Description for Creates or updates the function app settings of a static site.
create_user_roles_invitation_link	Creates an invitation link for a user with the role. Description for Creates an invitation link for a user with the role.
delete_build_database_connection	Delete a database connection for a static site build. Delete a database connection for a static site build.
delete_database_connection	Delete a database connection for a static site. Delete a database connection for a static site.
delete_static_site_user	Deletes the user entry from the static site. Description for Deletes the user entry from the static site.
detach_user_provided_function_app_from_static_site	Detach the user provided function app from the static site. Description for Detach the user provided function app from the static site.
detach_user_provided_function_app_from_static_site_build	Detach the user provided function app from the static site build. Description for Detach the user provided function app from the static site build.
get_basic_auth	Gets the basic auth properties for a static site. Description for Gets the basic auth properties for a static site.
get_build_database_connection	Returns overview of a database connection for a static site build by name. Returns overview of a database connection for a static site build by name.
get_build_database_connection_with_details	Returns details of a database connection for a static site build by name. Returns details of a database connection for a static site build by name.
get_build_database_connections	Returns overviews of database connections for a static site build. Returns overviews of database connections for a static site build.
get_build_database_connections_with_details	Returns details of database connections for a static site build. Returns details of database connections for a static site build.
get_database_connection	Returns overview of a database connection for a static site by name. Returns overview of a database connection for a static site by name.
get_database_connection_with_details	Returns details of a database connection for a static site by name. Returns details of a database connection for a static site by name.
get_database_connections	Returns overviews of database connections for a static site. Returns overviews of database connections for a static site.
get_database_connections_with_details	Returns details of database connections for a static site. Returns details of database connections for a static site.
get_linked_backend	Returns the details of a linked backend linked to a static site by name. Returns the details of a linked backend linked to a static site by name.
get_linked_backend_for_build	Returns the details of a linked backend linked to a static site build by name. Returns the details of a linked backend linked to a static site build by name.
get_linked_backends	Returns details of all backends linked to a static site. Returns details of all backends linked to a static site.
get_linked_backends_for_build	Returns details of all backends linked to a static site build. Returns details of all backends linked to a static site build.
get_private_endpoint_connection	Gets a private endpoint connection. Description for Gets a private endpoint connection.
get_private_endpoint_connection_list	Gets the list of private endpoint connections associated with a static site. Description for Gets the list of private endpoint connections associated with a static site.
get_private_link_resources	Gets the private link resources. Description for Gets the private link resources.
get_static_site	Gets the details of a static site. Description for Gets the details of a static site.
get_static_site_build	Gets the details of a static site build. Description for Gets the details of a static site build.
get_static_site_builds	Gets all static site builds for a particular static site. Description for Gets all static site builds for a particular static site.
get_static_site_custom_domain	Gets an existing custom domain for a particular static site. Description for Gets an existing custom domain for a particular static site.
get_static_sites_by_resource_group	Gets all static sites in the specified resource group. Description for Gets all static sites in the specified resource group.
get_user_provided_function_app_for_static_site	Gets the details of the user provided function app registered with a static site. Description for Gets the details of the user provided function app registered with a static site.
get_user_provided_function_app_for_static_site_build	Gets the details of the user provided function app registered with a static site build. Description for Gets the details of the user provided function app registered with a static site build.
get_user_provided_function_apps_for_static_site	Gets the details of the user provided function apps registered with a static site. Description for Gets the details of the user provided function apps registered with a static site.
get_user_provided_function_apps_for_static_site_build	Gets the details of the user provided function apps registered with a static site build. Description for Gets the details of the user provided function apps registered with a static site build.
list	Get all Static Sites for a subscription. Description for Get all Static Sites for a subscription.
list_basic_auth	Gets the basic auth properties for a static site as a collection. Description for Gets the basic auth properties for a static site as a collection.
list_static_site_app_settings	Gets the application settings of a static site. Description for Gets the application settings of a static site.
list_static_site_build_app_settings	Gets the application settings of a static site build. Description for Gets the application settings of a static site build.
list_static_site_build_function_app_settings	Gets the application settings of a static site build. Description for Gets the application settings of a static site build.
list_static_site_build_functions	Gets the functions of a particular static site build. Description for Gets the functions of a particular static site build.
list_static_site_configured_roles	Lists the roles configured for the static site. Description for Lists the roles configured for the static site.
list_static_site_custom_domains	Gets all static site custom domains for a particular static site. Description for Gets all static site custom domains for a particular static site.
list_static_site_function_app_settings	Gets the application settings of a static site. Description for Gets the application settings of a static site.
list_static_site_functions	Gets the functions of a static site. Description for Gets the functions of a static site.
list_static_site_secrets	Lists the secrets for an existing static site. Description for Lists the secrets for an existing static site.
list_static_site_users	Gets the list of users of a static site. Description for Gets the list of users of a static site.
preview_workflow	Generates a preview workflow file for the static site. Description for Generates a preview workflow file for the static site.
reset_static_site_api_key	Resets the api key for an existing static site. Description for Resets the api key for an existing static site.
unlink_backend	Unlink a backend from a static site. Unlink a backend from a static site.
unlink_backend_from_build	Unlink a backend from a static site build. Unlink a backend from a static site build.
update_build_database_connection	Create or update a database connection for a static site build. Description for Create or update a database connection for a static site build.
update_database_connection	Create or update a database connection for a static site. Description for Create or update a database connection for a static site.
update_static_site	Creates a new static site in an existing resource group, or updates an existing static site. Description for Creates a new static site in an existing resource group, or updates an existing static site.
update_static_site_user	Updates a user entry with the listed roles. Description for Updates a user entry with the listed roles.

begin_approve_or_reject_private_endpoint_connection

Approves or rejects a private endpoint connection.

Description for Approves or rejects a private endpoint connection.

begin_approve_or_reject_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: _models.RemotePrivateEndpointConnectionARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RemotePrivateEndpointConnectionARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
private_endpoint_connection_name Required	str Name of the private endpoint connection. Required.
private_endpoint_wrapper Required	RemotePrivateEndpointConnectionARMResource or IO[bytes] Request body. Is either a RemotePrivateEndpointConnectionARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[RemotePrivateEndpointConnectionARMResource]	An instance of LROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_static_site

Creates a new static site in an existing resource group, or updates an existing static site.

Description for Creates a new static site in an existing resource group, or updates an existing static site.

begin_create_or_update_static_site(resource_group_name: str, name: str, static_site_envelope: _models.StaticSiteARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StaticSiteARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site to create or update. Required.
static_site_envelope Required	StaticSiteARMResource or IO[bytes] A JSON representation of the staticsite properties. See example. Is either a StaticSiteARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[StaticSiteARMResource]	An instance of LROPoller that returns either StaticSiteARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_static_site_custom_domain

Creates a new static site custom domain in an existing resource group and static site.

Description for Creates a new static site custom domain in an existing resource group and static site.

begin_create_or_update_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, static_site_custom_domain_request_properties_envelope: _models.StaticSiteCustomDomainRequestPropertiesARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StaticSiteCustomDomainOverviewARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
domain_name Required	str The custom domain to create. Required.
static_site_custom_domain_request_properties_envelope Required	StaticSiteCustomDomainRequestPropertiesARMResource or IO[bytes] A JSON representation of the static site custom domain request properties. See example. Is either a StaticSiteCustomDomainRequestPropertiesARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[StaticSiteCustomDomainOverviewARMResource]	An instance of LROPoller that returns either StaticSiteCustomDomainOverviewARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_zip_deployment_for_static_site

Deploys zipped content to a static site.

Description for Deploys zipped content to a static site.

begin_create_zip_deployment_for_static_site(resource_group_name: str, name: str, static_site_zip_deployment_envelope: _models.StaticSiteZipDeploymentARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
static_site_zip_deployment_envelope Required	StaticSiteZipDeploymentARMResource or IO[bytes] A JSON representation of the StaticSiteZipDeployment properties. See example. Is either a StaticSiteZipDeploymentARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_zip_deployment_for_static_site_build

Deploys zipped content to a specific environment of a static site.

Description for Deploys zipped content to a specific environment of a static site.

begin_create_zip_deployment_for_static_site_build(resource_group_name: str, name: str, environment_name: str, static_site_zip_deployment_envelope: _models.StaticSiteZipDeploymentARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str Name of the environment. Required.
static_site_zip_deployment_envelope Required	StaticSiteZipDeploymentARMResource or IO[bytes] A JSON representation of the StaticSiteZipDeployment properties. See example. Is either a StaticSiteZipDeploymentARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_private_endpoint_connection

Deletes a private endpoint connection.

Description for Deletes a private endpoint connection.

begin_delete_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> LROPoller[MutableMapping[str, Any]]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
private_endpoint_connection_name Required	str Name of the private endpoint connection. Required.

Returns

Type	Description
LROPoller[<xref:JSON>]	An instance of LROPoller that returns either JSON or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_static_site

Deletes a static site.

Description for Deletes a static site.

begin_delete_static_site(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site to delete. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_static_site_build

Deletes a static site build.

Description for Deletes a static site build.

begin_delete_static_site_build(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_static_site_custom_domain

Deletes a custom domain.

Description for Deletes a custom domain.

begin_delete_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
domain_name Required	str The custom domain to delete. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_detach_static_site

Detaches a static site.

Description for Detaches a static site.

begin_detach_static_site(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site to detach. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_link_backend

Link backend to a static site.

Link backend to a static site.

begin_link_backend(resource_group_name: str, name: str, linked_backend_name: str, static_site_linked_backend_envelope: _models.StaticSiteLinkedBackendARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StaticSiteLinkedBackendARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
linked_backend_name Required	str Name of the backend to link to the static site. Required.
static_site_linked_backend_envelope Required	StaticSiteLinkedBackendARMResource or IO[bytes] A JSON representation of the linked backend request properties. Is either a StaticSiteLinkedBackendARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[StaticSiteLinkedBackendARMResource]	An instance of LROPoller that returns either StaticSiteLinkedBackendARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_link_backend_to_build

Link backend to a static site build.

Link backend to a static site build.

begin_link_backend_to_build(resource_group_name: str, name: str, environment_name: str, linked_backend_name: str, static_site_linked_backend_envelope: _models.StaticSiteLinkedBackendARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StaticSiteLinkedBackendARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
linked_backend_name Required	str Name of the backend to link to the static site. Required.
static_site_linked_backend_envelope Required	StaticSiteLinkedBackendARMResource or IO[bytes] A JSON representation of the linked backend request properties. Is either a StaticSiteLinkedBackendARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[StaticSiteLinkedBackendARMResource]	An instance of LROPoller that returns either StaticSiteLinkedBackendARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_register_user_provided_function_app_with_static_site

Register a user provided function app with a static site.

Description for Register a user provided function app with a static site.

begin_register_user_provided_function_app_with_static_site(resource_group_name: str, name: str, function_app_name: str, static_site_user_provided_function_envelope: _models.StaticSiteUserProvidedFunctionAppARMResource, is_forced: bool | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StaticSiteUserProvidedFunctionAppARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
function_app_name Required	str Name of the function app to register with the static site. Required.
static_site_user_provided_function_envelope Required	StaticSiteUserProvidedFunctionAppARMResource or IO[bytes] A JSON representation of the user provided function app properties. See example. Is either a StaticSiteUserProvidedFunctionAppARMResource type or a IO[bytes] type. Required.
is_forced Required	bool Specify <code>true</code> to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is <code>false</code>. Default value is None.

Returns

Type	Description
LROPoller[StaticSiteUserProvidedFunctionAppARMResource]	An instance of LROPoller that returns either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_register_user_provided_function_app_with_static_site_build

Register a user provided function app with a static site build.

Description for Register a user provided function app with a static site build.

begin_register_user_provided_function_app_with_static_site_build(resource_group_name: str, name: str, environment_name: str, function_app_name: str, static_site_user_provided_function_envelope: _models.StaticSiteUserProvidedFunctionAppARMResource, is_forced: bool | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StaticSiteUserProvidedFunctionAppARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
function_app_name Required	str Name of the function app to register with the static site build. Required.
static_site_user_provided_function_envelope Required	StaticSiteUserProvidedFunctionAppARMResource or IO[bytes] A JSON representation of the user provided function app properties. See example. Is either a StaticSiteUserProvidedFunctionAppARMResource type or a IO[bytes] type. Required.
is_forced Required	bool Specify <code>true</code> to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is <code>false</code>. Default value is None.

Returns

Type	Description
LROPoller[StaticSiteUserProvidedFunctionAppARMResource]	An instance of LROPoller that returns either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_validate_backend

Validates that a backend can be linked to a static site.

Validates that a backend can be linked to a static site.

begin_validate_backend(resource_group_name: str, name: str, linked_backend_name: str, static_site_linked_backend_envelope: _models.StaticSiteLinkedBackendARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
linked_backend_name Required	str Name of the linked backend that should be retrieved. Required.
static_site_linked_backend_envelope Required	StaticSiteLinkedBackendARMResource or IO[bytes] A JSON representation of the linked backend request properties. Is either a StaticSiteLinkedBackendARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_validate_backend_for_build

Validates that a backend can be linked to a static site build.

Validates that a backend can be linked to a static site build.

begin_validate_backend_for_build(resource_group_name: str, name: str, environment_name: str, linked_backend_name: str, static_site_linked_backend_envelope: _models.StaticSiteLinkedBackendARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
linked_backend_name Required	str Name of the linked backend that should be retrieved. Required.
static_site_linked_backend_envelope Required	StaticSiteLinkedBackendARMResource or IO[bytes] A JSON representation of the linked backend request properties. Is either a StaticSiteLinkedBackendARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_validate_custom_domain_can_be_added_to_static_site

Validates a particular custom domain can be added to a static site.

Description for Validates a particular custom domain can be added to a static site.

begin_validate_custom_domain_can_be_added_to_static_site(resource_group_name: str, name: str, domain_name: str, static_site_custom_domain_request_properties_envelope: _models.StaticSiteCustomDomainRequestPropertiesARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
domain_name Required	str The custom domain to validate. Required.
static_site_custom_domain_request_properties_envelope Required	StaticSiteCustomDomainRequestPropertiesARMResource or IO[bytes] A JSON representation of the static site custom domain request properties. See example. Is either a StaticSiteCustomDomainRequestPropertiesARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_basic_auth

Adds or updates basic auth for a static site.

Description for Adds or updates basic auth for a static site.

create_or_update_basic_auth(resource_group_name: str, name: str, basic_auth_name: str | _models.BasicAuthName, basic_auth_envelope: _models.StaticSiteBasicAuthPropertiesARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StaticSiteBasicAuthPropertiesARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
basic_auth_name Required	str or BasicAuthName name of the basic auth entry. "default" Required.
basic_auth_envelope Required	StaticSiteBasicAuthPropertiesARMResource or IO[bytes] A JSON representation of the basic auth properties. Is either a StaticSiteBasicAuthPropertiesARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
StaticSiteBasicAuthPropertiesARMResource	StaticSiteBasicAuthPropertiesARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_build_database_connection

Create or update a database connection for a static site build.

Description for Create or update a database connection for a static site build.

create_or_update_build_database_connection(resource_group_name: str, name: str, environment_name: str, database_connection_name: str, database_connection_request_envelope: _models.DatabaseConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
database_connection_name Required	str Name of the database connection. Required.
database_connection_request_envelope Required	DatabaseConnection or IO[bytes] A JSON representation of the database connection request properties. Is either a DatabaseConnection type or a IO[bytes] type. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_database_connection

Create or update a database connection for a static site.

Description for Create or update a database connection for a static site.

create_or_update_database_connection(resource_group_name: str, name: str, database_connection_name: str, database_connection_request_envelope: _models.DatabaseConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
database_connection_name Required	str Name of the database connection. Required.
database_connection_request_envelope Required	DatabaseConnection or IO[bytes] A JSON representation of the database connection request properties. Is either a DatabaseConnection type or a IO[bytes] type. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_static_site_app_settings

Creates or updates the app settings of a static site.

Description for Creates or updates the app settings of a static site.

create_or_update_static_site_app_settings(resource_group_name: str, name: str, app_settings: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
app_settings Required	StringDictionary or IO[bytes] The dictionary containing the static site app settings to update. Is either a StringDictionary type or a IO[bytes] type. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_static_site_build_app_settings

Creates or updates the app settings of a static site build.

Description for Creates or updates the app settings of a static site build.

create_or_update_static_site_build_app_settings(resource_group_name: str, name: str, environment_name: str, app_settings: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
app_settings Required	StringDictionary or IO[bytes] The dictionary containing the static site app settings to update. Is either a StringDictionary type or a IO[bytes] type. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_static_site_build_function_app_settings

Creates or updates the function app settings of a static site build.

Description for Creates or updates the function app settings of a static site build.

create_or_update_static_site_build_function_app_settings(resource_group_name: str, name: str, environment_name: str, app_settings: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
app_settings Required	StringDictionary or IO[bytes] The dictionary containing the static site function app settings to update. Is either a StringDictionary type or a IO[bytes] type. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_static_site_function_app_settings

Creates or updates the function app settings of a static site.

Description for Creates or updates the function app settings of a static site.

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	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
app_settings Required	StringDictionary or IO[bytes] The dictionary containing the static site function app settings to update. Is either a StringDictionary type or a IO[bytes] type. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_user_roles_invitation_link

Creates an invitation link for a user with the role.

Description for Creates an invitation link for a user with the role.

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	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
static_site_user_roles_invitation_envelope Required	StaticSiteUserInvitationRequestResource or IO[bytes] Is either a StaticSiteUserInvitationRequestResource type or a IO[bytes] type. Required.

Returns

Type	Description
StaticSiteUserInvitationResponseResource	StaticSiteUserInvitationResponseResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_build_database_connection

Delete a database connection for a static site build.

Delete a database connection for a static site build.

delete_build_database_connection(resource_group_name: str, name: str, environment_name: str, database_connection_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
database_connection_name Required	str Name of the database connection. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_database_connection

Delete a database connection for a static site.

Delete a database connection for a static site.

delete_database_connection(resource_group_name: str, name: str, database_connection_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
database_connection_name Required	str Name of the database connection. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_static_site_user

Deletes the user entry from the static site.

Description for Deletes the user entry from the static site.

delete_static_site_user(resource_group_name: str, name: str, authprovider: str, userid: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the staticsite. Required.
authprovider Required	str The auth provider for this user. Required.
userid Required	str The user id of the user. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

detach_user_provided_function_app_from_static_site

Detach the user provided function app from the static site.

Description for Detach the user provided function app from the static site.

detach_user_provided_function_app_from_static_site(resource_group_name: str, name: str, function_app_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
function_app_name Required	str Name of the function app registered with the static site. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

detach_user_provided_function_app_from_static_site_build

Detach the user provided function app from the static site build.

Description for Detach the user provided function app from the static site build.

detach_user_provided_function_app_from_static_site_build(resource_group_name: str, name: str, environment_name: str, function_app_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
function_app_name Required	str Name of the function app registered with the static site build. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_basic_auth

Gets the basic auth properties for a static site.

Description for Gets the basic auth properties for a static site.

get_basic_auth(resource_group_name: str, name: str, basic_auth_name: str | BasicAuthName, **kwargs: Any) -> StaticSiteBasicAuthPropertiesARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
basic_auth_name Required	str or BasicAuthName name of the basic auth entry. "default" Required.

Returns

Type	Description
StaticSiteBasicAuthPropertiesARMResource	StaticSiteBasicAuthPropertiesARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_build_database_connection

Returns overview of a database connection for a static site build by name.

Returns overview of a database connection for a static site build by name.

get_build_database_connection(resource_group_name: str, name: str, environment_name: str, database_connection_name: str, **kwargs: Any) -> DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
database_connection_name Required	str Name of the database connection. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_build_database_connection_with_details

Returns details of a database connection for a static site build by name.

Returns details of a database connection for a static site build by name.

get_build_database_connection_with_details(resource_group_name: str, name: str, environment_name: str, database_connection_name: str, **kwargs: Any) -> DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
database_connection_name Required	str Name of the database connection. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_build_database_connections

Returns overviews of database connections for a static site build.

Returns overviews of database connections for a static site build.

get_build_database_connections(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> Iterable[DatabaseConnection]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
ItemPaged[DatabaseConnection]	An iterator like instance of either DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_build_database_connections_with_details

Returns details of database connections for a static site build.

Returns details of database connections for a static site build.

get_build_database_connections_with_details(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> Iterable[DatabaseConnection]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
ItemPaged[DatabaseConnection]	An iterator like instance of either DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_database_connection

Returns overview of a database connection for a static site by name.

Returns overview of a database connection for a static site by name.

get_database_connection(resource_group_name: str, name: str, database_connection_name: str, **kwargs: Any) -> DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
database_connection_name Required	str Name of the database connection. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_database_connection_with_details

Returns details of a database connection for a static site by name.

Returns details of a database connection for a static site by name.

get_database_connection_with_details(resource_group_name: str, name: str, database_connection_name: str, **kwargs: Any) -> DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
database_connection_name Required	str Name of the database connection. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_database_connections

Returns overviews of database connections for a static site.

Returns overviews of database connections for a static site.

get_database_connections(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[DatabaseConnection]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[DatabaseConnection]	An iterator like instance of either DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_database_connections_with_details

Returns details of database connections for a static site.

Returns details of database connections for a static site.

get_database_connections_with_details(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[DatabaseConnection]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[DatabaseConnection]	An iterator like instance of either DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_linked_backend

Returns the details of a linked backend linked to a static site by name.

Returns the details of a linked backend linked to a static site by name.

get_linked_backend(resource_group_name: str, name: str, linked_backend_name: str, **kwargs: Any) -> StaticSiteLinkedBackendARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
linked_backend_name Required	str Name of the linked backend that should be retrieved. Required.

Returns

Type	Description
StaticSiteLinkedBackendARMResource	StaticSiteLinkedBackendARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_linked_backend_for_build

Returns the details of a linked backend linked to a static site build by name.

Returns the details of a linked backend linked to a static site build by name.

get_linked_backend_for_build(resource_group_name: str, name: str, environment_name: str, linked_backend_name: str, **kwargs: Any) -> StaticSiteLinkedBackendARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
linked_backend_name Required	str Name of the linked backend that should be retrieved. Required.

Returns

Type	Description
StaticSiteLinkedBackendARMResource	StaticSiteLinkedBackendARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_linked_backends

Returns details of all backends linked to a static site.

Returns details of all backends linked to a static site.

get_linked_backends(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[StaticSiteLinkedBackendARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[StaticSiteLinkedBackendARMResource]	An iterator like instance of either StaticSiteLinkedBackendARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_linked_backends_for_build

Returns details of all backends linked to a static site build.

Returns details of all backends linked to a static site build.

get_linked_backends_for_build(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> Iterable[StaticSiteLinkedBackendARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
ItemPaged[StaticSiteLinkedBackendARMResource]	An iterator like instance of either StaticSiteLinkedBackendARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_private_endpoint_connection

Gets a private endpoint connection.

Description for Gets a private endpoint connection.

get_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> RemotePrivateEndpointConnectionARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
private_endpoint_connection_name Required	str Name of the private endpoint connection. Required.

Returns

Type	Description
RemotePrivateEndpointConnectionARMResource	RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_private_endpoint_connection_list

Gets the list of private endpoint connections associated with a static site.

Description for Gets the list of private endpoint connections associated with a static site.

get_private_endpoint_connection_list(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[RemotePrivateEndpointConnectionARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[RemotePrivateEndpointConnectionARMResource]	An iterator like instance of either RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_private_link_resources

Gets the private link resources.

Description for Gets the private link resources.

get_private_link_resources(resource_group_name: str, name: str, **kwargs: Any) -> PrivateLinkResourcesWrapper

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the site. Required.

Returns

Type	Description
PrivateLinkResourcesWrapper	PrivateLinkResourcesWrapper or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_static_site

Gets the details of a static site.

Description for Gets the details of a static site.

get_static_site(resource_group_name: str, name: str, **kwargs: Any) -> StaticSiteARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
StaticSiteARMResource	StaticSiteARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_static_site_build

Gets the details of a static site build.

Description for Gets the details of a static site build.

get_static_site_build(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> StaticSiteBuildARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
StaticSiteBuildARMResource	StaticSiteBuildARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_static_site_builds

Gets all static site builds for a particular static site.

Description for Gets all static site builds for a particular static site.

get_static_site_builds(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[StaticSiteBuildARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[StaticSiteBuildARMResource]	An iterator like instance of either StaticSiteBuildARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_static_site_custom_domain

Gets an existing custom domain for a particular static site.

Description for Gets an existing custom domain for a particular static site.

get_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, **kwargs: Any) -> StaticSiteCustomDomainOverviewARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site resource to search in. Required.
domain_name Required	str The custom domain name. Required.

Returns

Type	Description
StaticSiteCustomDomainOverviewARMResource	StaticSiteCustomDomainOverviewARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_static_sites_by_resource_group

Gets all static sites in the specified resource group.

Description for Gets all static sites in the specified resource group.

get_static_sites_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[StaticSiteARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.

Returns

Type	Description
ItemPaged[StaticSiteARMResource]	An iterator like instance of either StaticSiteARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_user_provided_function_app_for_static_site

Gets the details of the user provided function app registered with a static site.

Description for Gets the details of the user provided function app registered with a static site.

get_user_provided_function_app_for_static_site(resource_group_name: str, name: str, function_app_name: str, **kwargs: Any) -> StaticSiteUserProvidedFunctionAppARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
function_app_name Required	str Name of the function app registered with the static site. Required.

Returns

Type	Description
StaticSiteUserProvidedFunctionAppARMResource	StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_user_provided_function_app_for_static_site_build

Gets the details of the user provided function app registered with a static site build.

Description for Gets the details of the user provided function app registered with a static site build.

get_user_provided_function_app_for_static_site_build(resource_group_name: str, name: str, environment_name: str, function_app_name: str, **kwargs: Any) -> StaticSiteUserProvidedFunctionAppARMResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
function_app_name Required	str Name of the function app registered with the static site build. Required.

Returns

Type	Description
StaticSiteUserProvidedFunctionAppARMResource	StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_user_provided_function_apps_for_static_site

Gets the details of the user provided function apps registered with a static site.

Description for Gets the details of the user provided function apps registered with a static site.

get_user_provided_function_apps_for_static_site(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[StaticSiteUserProvidedFunctionAppARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[StaticSiteUserProvidedFunctionAppARMResource]	An iterator like instance of either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_user_provided_function_apps_for_static_site_build

Gets the details of the user provided function apps registered with a static site build.

Description for Gets the details of the user provided function apps registered with a static site build.

get_user_provided_function_apps_for_static_site_build(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> Iterable[StaticSiteUserProvidedFunctionAppARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
ItemPaged[StaticSiteUserProvidedFunctionAppARMResource]	An iterator like instance of either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Get all Static Sites for a subscription.

Description for Get all Static Sites for a subscription.

list(**kwargs: Any) -> Iterable[StaticSiteARMResource]

Returns

Type	Description
ItemPaged[StaticSiteARMResource]	An iterator like instance of either StaticSiteARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_basic_auth

Gets the basic auth properties for a static site as a collection.

Description for Gets the basic auth properties for a static site as a collection.

list_basic_auth(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[StaticSiteBasicAuthPropertiesARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[StaticSiteBasicAuthPropertiesARMResource]	An iterator like instance of either StaticSiteBasicAuthPropertiesARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_app_settings

Gets the application settings of a static site.

Description for Gets the application settings of a static site.

list_static_site_app_settings(resource_group_name: str, name: str, **kwargs: Any) -> StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_build_app_settings

Gets the application settings of a static site build.

Description for Gets the application settings of a static site build.

list_static_site_build_app_settings(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_build_function_app_settings

Gets the application settings of a static site build.

Description for Gets the application settings of a static site build.

list_static_site_build_function_app_settings(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_build_functions

Gets the functions of a particular static site build.

Description for Gets the functions of a particular static site build.

list_static_site_build_functions(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> Iterable[StaticSiteFunctionOverviewARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.

Returns

Type	Description
ItemPaged[StaticSiteFunctionOverviewARMResource]	An iterator like instance of either StaticSiteFunctionOverviewARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_configured_roles

Lists the roles configured for the static site.

Description for Lists the roles configured for the static site.

list_static_site_configured_roles(resource_group_name: str, name: str, **kwargs: Any) -> StringList

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
StringList	StringList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_custom_domains

Gets all static site custom domains for a particular static site.

Description for Gets all static site custom domains for a particular static site.

list_static_site_custom_domains(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[StaticSiteCustomDomainOverviewARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site resource to search in. Required.

Returns

Type	Description
ItemPaged[StaticSiteCustomDomainOverviewARMResource]	An iterator like instance of either StaticSiteCustomDomainOverviewARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_function_app_settings

Gets the application settings of a static site.

Description for Gets the application settings of a static site.

list_static_site_function_app_settings(resource_group_name: str, name: str, **kwargs: Any) -> StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_functions

Gets the functions of a static site.

Description for Gets the functions of a static site.

list_static_site_functions(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[StaticSiteFunctionOverviewARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
ItemPaged[StaticSiteFunctionOverviewARMResource]	An iterator like instance of either StaticSiteFunctionOverviewARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_secrets

Lists the secrets for an existing static site.

Description for Lists the secrets for an existing static site.

list_static_site_secrets(resource_group_name: str, name: str, **kwargs: Any) -> StringDictionary

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.

Returns

Type	Description
StringDictionary	StringDictionary or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_static_site_users

Gets the list of users of a static site.

Description for Gets the list of users of a static site.

list_static_site_users(resource_group_name: str, name: str, authprovider: str, **kwargs: Any) -> Iterable[StaticSiteUserARMResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
authprovider Required	str The auth provider for the users. Required.

Returns

Type	Description
ItemPaged[StaticSiteUserARMResource]	An iterator like instance of either StaticSiteUserARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

preview_workflow

Generates a preview workflow file for the static site.

Description for Generates a preview workflow file for the static site.

preview_workflow(location: str, static_sites_workflow_preview_request: _models.StaticSitesWorkflowPreviewRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StaticSitesWorkflowPreview

Parameters

Name	Description
location Required	str Location where you plan to create the static site. Required.
static_sites_workflow_preview_request Required	StaticSitesWorkflowPreviewRequest or IO[bytes] A JSON representation of the StaticSitesWorkflowPreviewRequest properties. See example. Is either a StaticSitesWorkflowPreviewRequest type or a IO[bytes] type. Required.

Returns

Type	Description
StaticSitesWorkflowPreview	StaticSitesWorkflowPreview or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

reset_static_site_api_key

Resets the api key for an existing static site.

Description for Resets the api key for an existing static site.

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	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
reset_properties_envelope Required	StaticSiteResetPropertiesARMResource or IO[bytes] Is either a StaticSiteResetPropertiesARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

unlink_backend

Unlink a backend from a static site.

Unlink a backend from a static site.

unlink_backend(resource_group_name: str, name: str, linked_backend_name: str, is_cleaning_auth_config: bool | None = None, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
linked_backend_name Required	str Name of the backend linked to the static site. Required.
is_cleaning_auth_config Required	bool Decides if Easy Auth configuration will be removed from backend configuration. Default value is None.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

unlink_backend_from_build

Unlink a backend from a static site build.

Unlink a backend from a static site build.

unlink_backend_from_build(resource_group_name: str, name: str, environment_name: str, linked_backend_name: str, is_cleaning_auth_config: bool | None = None, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
linked_backend_name Required	str Name of the backend linked to the static site. Required.
is_cleaning_auth_config Required	bool Decides if auth will be removed from backend configuration. Default value is None.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_build_database_connection

Create or update a database connection for a static site build.

Description for Create or update a database connection for a static site build.

update_build_database_connection(resource_group_name: str, name: str, environment_name: str, database_connection_name: str, database_connection_request_envelope: _models.DatabaseConnectionPatchRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
environment_name Required	str The stage site identifier. Required.
database_connection_name Required	str Name of the database connection. Required.
database_connection_request_envelope Required	DatabaseConnectionPatchRequest or IO[bytes] A JSON representation of the database connection request properties. Is either a DatabaseConnectionPatchRequest type or a IO[bytes] type. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_database_connection

Create or update a database connection for a static site.

Description for Create or update a database connection for a static site.

update_database_connection(resource_group_name: str, name: str, database_connection_name: str, database_connection_request_envelope: _models.DatabaseConnectionPatchRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DatabaseConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
database_connection_name Required	str Name of the database connection. Required.
database_connection_request_envelope Required	DatabaseConnectionPatchRequest or IO[bytes] A JSON representation of the database connection request properties. Is either a DatabaseConnectionPatchRequest type or a IO[bytes] type. Required.

Returns

Type	Description
DatabaseConnection	DatabaseConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_static_site

Creates a new static site in an existing resource group, or updates an existing static site.

Description for Creates a new static site in an existing resource group, or updates an existing static site.

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	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site to create or update. Required.
static_site_envelope Required	StaticSitePatchResource or IO[bytes] A JSON representation of the staticsite properties. See example. Is either a StaticSitePatchResource type or a IO[bytes] type. Required.

Returns

Type	Description
StaticSiteARMResource	StaticSiteARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_static_site_user

Updates a user entry with the listed roles.

Description for Updates a user entry with the listed roles.

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	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the static site. Required.
authprovider Required	str The auth provider for this user. Required.
userid Required	str The user id of the user. Required.
static_site_user_envelope Required	StaticSiteUserARMResource or IO[bytes] A JSON representation of the StaticSiteUser properties. See example. Is either a StaticSiteUserARMResource type or a IO[bytes] type. Required.

Returns

Type	Description
StaticSiteUserARMResource	StaticSiteUserARMResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.web.v2023_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2023_01_01\\models\\__init__.py'>