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

create_or_update_static_site	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.
create_or_update_static_site_build_function_app_settings	Creates or updates the function app settings of a static site build. Creates or updates the function app settings of a static site build.
create_or_update_static_site_custom_domain	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.
create_or_update_static_site_function_app_settings	Creates or updates the function app settings of a static site. 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. Creates an invitation link for a user with the role.
delete_static_site	Deletes a static site. Deletes a static site.
delete_static_site_build	Deletes a static site build. Deletes a static site build.
delete_static_site_custom_domain	Deletes a custom domain. Deletes a custom domain.
delete_static_site_user	Deletes the user entry from the static site. Deletes the user entry from the static site.
detach_static_site	Detaches a static site. Detaches a static site.
get_static_site	Gets the details of a static site. Gets the details of a static site.
get_static_site_build	Gets the details of a static site build. Gets the details of a static site build.
get_static_site_builds	Gets all static site builds for a particular static site. Gets all static site builds for a particular static site.
get_static_sites_by_resource_group	Gets all static sites in the specified resource group. Gets all static sites in the specified resource group.
list	Get all Static Sites for a subscription. Get all Static Sites for a subscription.
list_static_site_build_function_app_settings	Gets the application settings of a static site. Gets the application settings of a static site.
list_static_site_build_functions	Gets the functions of a particular static site build. Gets the functions of a particular static site build.
list_static_site_custom_domains	Gets all static site custom domains for a particular static site. 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. Gets the application settings of a static site.
list_static_site_functions	Gets the functions of a static site. Gets the functions of a static site.
list_static_site_secrets	Lists the secrets for an existing static site. Lists the secrets for an existing static site.
list_static_site_users	Gets the list of users of a static site. Gets the list of users of a static site.
preview_workflow	Generates a preview workflow file for the static site. Generates a preview workflow file for the static site.
reset_static_site_api_key	Resets the api key for an existing static site. Resets the api key for an existing static site.
update_static_site	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.
update_static_site_user	Updates a user entry with the listed roles. Updates a user entry with the listed roles.
validate_custom_domain_can_be_added_to_static_site	Validates a particular custom domain can be added to a static site. Validates a particular custom domain can be added to a static site.

create_or_update_static_site

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.

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	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
StaticSiteARMResource	StaticSiteARMResource 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.

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, pr_id: 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.
pr_id Required	str The stage site identifier. Required.
app_settings Required	StringDictionary or IO[bytes] 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_custom_domain

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.

create_or_update_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. Required.
domain_name Required	str The custom domain to create. Required.

Returns

Type	Description
StaticSiteCustomDomainOverviewARMResource	StaticSiteCustomDomainOverviewARMResource 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.

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] 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.

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_static_site

Deletes a static site.

Deletes a static site.

delete_static_site(resource_group_name: str, 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 to delete. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

delete_static_site_build

Deletes a static site build.

Deletes a static site build.

delete_static_site_build(resource_group_name: str, name: str, pr_id: 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.
pr_id Required	str The stage site identifier. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

delete_static_site_custom_domain

Deletes a custom domain.

Deletes a custom domain.

delete_static_site_custom_domain(resource_group_name: str, name: str, domain_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.
domain_name Required	str The custom domain to delete. 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.

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_static_site

Detaches a static site.

Detaches a static site.

detach_static_site(resource_group_name: str, 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 to detach. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_static_site

Gets the details of a static site.

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.

Gets the details of a static site build.

get_static_site_build(resource_group_name: str, name: str, pr_id: 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.
pr_id 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.

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_sites_by_resource_group

Gets all static sites in the specified resource group.

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

list

Get all Static Sites for a subscription.

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_static_site_build_function_app_settings

Gets the application settings of a static site.

Gets the application settings of a static site.

list_static_site_build_function_app_settings(resource_group_name: str, name: str, pr_id: 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.
pr_id 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.

Gets the functions of a particular static site build.

list_static_site_build_functions(resource_group_name: str, name: str, pr_id: 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.
pr_id 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_custom_domains

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

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.

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.

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.

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.

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.

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.

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

update_static_site

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.

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.

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

validate_custom_domain_can_be_added_to_static_site

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

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

validate_custom_domain_can_be_added_to_static_site(resource_group_name: str, name: str, domain_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.
domain_name Required	str The custom domain to validate. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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'>