StaticSitesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:static_sites> attribute.
- Inheritance
-
builtins.objectStaticSitesOperations
Constructor
StaticSitesOperations(*args, **kwargs)Methods
| begin_approve_or_reject_private_endpoint_connection |
Approves or rejects a private endpoint connection. 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. 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. 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. 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. Deploys zipped content to a specific environment of a static site. |
| begin_delete_private_endpoint_connection |
Deletes a private endpoint connection. Deletes a private endpoint connection. |
| begin_delete_static_site |
Deletes a static site. Deletes a static site. |
| begin_delete_static_site_build |
Deletes a static site build. Deletes a static site build. |
| begin_delete_static_site_custom_domain |
Deletes a custom domain. Deletes a custom domain. |
| begin_detach_static_site |
Detaches a static site. Detaches a static site. |
| begin_register_user_provided_function_app_with_static_site |
Register a user provided function app with a static site. 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. Register a user provided function app with 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. Validates a particular custom domain can be added to a static site. |
| create_or_update_static_site_app_settings |
Creates or updates the app settings of a static site. 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. 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. 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. 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_user |
Deletes the user entry from the static site. 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. 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. Detach the user provided function app from the static site build. |
| get_private_endpoint_connection |
Gets a private endpoint connection. Gets a private endpoint connection. |
| get_private_endpoint_connection_list |
Gets the list of private endpoint connections associated with a static site. Gets the list of private endpoint connections associated with a static site. |
| get_private_link_resources |
Gets the private link resources. Gets the private link resources. |
| 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_site_custom_domain |
Gets an existing custom domain for a particular static site. 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. 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. 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. 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. 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. Gets the details of the user provided function apps registered with a static site build. |
| list |
Get all Static Sites for a subscription. Get all Static Sites for a subscription. |
| list_static_site_app_settings |
Gets the application settings of a static site. Gets the application settings of a static site. |
| list_static_site_build_app_settings |
Gets the application settings of a static site build. 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. Gets the application settings of a static site build. |
| 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_configured_roles |
Lists the roles configured for the static site. Lists the roles configured for the static site. |
| 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. |
begin_approve_or_reject_private_endpoint_connection
Approves or rejects a private endpoint connection.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
private_endpoint_connection_name
Required
|
Name of the private endpoint connection. Required. |
|
private_endpoint_wrapper
Required
|
Request body. Is either a RemotePrivateEndpointConnectionARMResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_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.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site to create or update. Required. |
|
static_site_envelope
Required
|
A JSON representation of the staticsite properties. See example. Is either a StaticSiteARMResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either StaticSiteARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_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.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
domain_name
Required
|
The custom domain to create. Required. |
|
static_site_custom_domain_request_properties_envelope
Required
|
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 |
|---|---|
|
An instance of LROPoller that returns either StaticSiteCustomDomainOverviewARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_create_zip_deployment_for_static_site
Deploys zipped content to a static site.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
static_site_zip_deployment_envelope
Required
|
A JSON representation of the StaticSiteZipDeployment properties. See example. Is either a StaticSiteZipDeploymentARMResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_create_zip_deployment_for_static_site_build
Deploys zipped content to a specific environment of a static site.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
Name of the environment. Required. |
|
static_site_zip_deployment_envelope
Required
|
A JSON representation of the StaticSiteZipDeployment properties. See example. Is either a StaticSiteZipDeploymentARMResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete_private_endpoint_connection
Deletes a private endpoint connection.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
private_endpoint_connection_name
Required
|
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 |
|---|---|
begin_delete_static_site
Deletes a static site.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site to delete. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete_static_site_build
Deletes a static site build.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete_static_site_custom_domain
Deletes a custom domain.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
domain_name
Required
|
The custom domain to delete. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_detach_static_site
Detaches a static site.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site to detach. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_register_user_provided_function_app_with_static_site
Register a user provided function app with a static site.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
function_app_name
Required
|
Name of the function app to register with the static site. Required. |
|
static_site_user_provided_function_envelope
Required
|
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
|
Specify |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_register_user_provided_function_app_with_static_site_build
Register a user provided function app with a static site build.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
|
function_app_name
Required
|
Name of the function app to register with the static site build. Required. |
|
static_site_user_provided_function_envelope
Required
|
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
|
Specify |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_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.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
domain_name
Required
|
The custom domain to validate. Required. |
|
static_site_custom_domain_request_properties_envelope
Required
|
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 |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update_static_site_app_settings
Creates or updates the app settings of a static site.
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.StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
app_settings
Required
|
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 or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update_static_site_build_app_settings
Creates or updates the app settings of a static site build.
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.StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
|
app_settings
Required
|
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 or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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, environment_name: str, app_settings: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
|
app_settings
Required
|
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 or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
app_settings
Required
|
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 or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.StaticSiteUserInvitationResponseResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
static_site_user_roles_invitation_envelope
Required
|
Is either a StaticSiteUserInvitationRequestResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteUserInvitationResponseResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the staticsite. Required. |
|
authprovider
Required
|
The auth provider for this user. Required. |
|
userid
Required
|
The user id of the user. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
detach_user_provided_function_app_from_static_site
Detach the user provided function app from the static site.
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
function_app_name
Required
|
Name of the function app registered with the static site. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
detach_user_provided_function_app_from_static_site_build
Detach the user provided function app from the static site build.
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
|
function_app_name
Required
|
Name of the function app registered with the static site build. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_private_endpoint_connection
Gets a private endpoint connection.
Gets a private endpoint connection.
get_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> RemotePrivateEndpointConnectionARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
private_endpoint_connection_name
Required
|
Name of the private endpoint connection. Required. |
Returns
| Type | Description |
|---|---|
|
RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_private_endpoint_connection_list
Gets the list of private endpoint connections associated with a static site.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_private_link_resources
Gets the private link resources.
Gets the private link resources.
get_private_link_resources(resource_group_name: str, name: str, **kwargs: Any) -> PrivateLinkResourcesWrapperParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the site. Required. |
Returns
| Type | Description |
|---|---|
|
PrivateLinkResourcesWrapper or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> StaticSiteARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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, environment_name: str, **kwargs: Any) -> StaticSiteBuildARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteBuildARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteBuildARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_static_site_custom_domain
Gets an existing custom domain for a particular static site.
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) -> StaticSiteCustomDomainOverviewARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site resource to search in. Required. |
|
domain_name
Required
|
The custom domain name. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteCustomDomainOverviewARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
Name of the resource group to which the resource belongs. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_user_provided_function_app_for_static_site
Gets the details of the user provided function app registered with a static site.
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) -> StaticSiteUserProvidedFunctionAppARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
function_app_name
Required
|
Name of the function app registered with the static site. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_user_provided_function_app_for_static_site_build
Gets the details of the user provided function app registered with a static site build.
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) -> StaticSiteUserProvidedFunctionAppARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
|
function_app_name
Required
|
Name of the function app registered with the static site build. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_user_provided_function_apps_for_static_site
Gets the details of the user provided function apps registered with a static site.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_user_provided_function_apps_for_static_site_build
Gets the details of the user provided function apps registered with a static site build.
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Get all Static Sites for a subscription.
Get all Static Sites for a subscription.
list(**kwargs: Any) -> Iterable[StaticSiteARMResource]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_static_site_app_settings
Gets the application settings of a static site.
Gets the application settings of a static site.
list_static_site_app_settings(resource_group_name: str, name: str, **kwargs: Any) -> StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
StringDictionary or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_static_site_build_app_settings
Gets the application settings of a static site build.
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) -> StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
Returns
| Type | Description |
|---|---|
|
StringDictionary or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_static_site_build_function_app_settings
Gets the application settings of a static site build.
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) -> StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
Returns
| Type | Description |
|---|---|
|
StringDictionary or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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, environment_name: str, **kwargs: Any) -> Iterable[StaticSiteFunctionOverviewARMResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
environment_name
Required
|
The stage site identifier. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteFunctionOverviewARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_static_site_configured_roles
Lists the roles configured for the static site.
Lists the roles configured for the static site.
list_static_site_configured_roles(resource_group_name: str, name: str, **kwargs: Any) -> StringListParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
StringList or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site resource to search in. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteCustomDomainOverviewARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
StringDictionary or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteFunctionOverviewARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> StringDictionaryParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
Returns
| Type | Description |
|---|---|
|
StringDictionary or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
authprovider
Required
|
The auth provider for the users. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either StaticSiteUserARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.StaticSitesWorkflowPreviewParameters
| Name | Description |
|---|---|
|
location
Required
|
Location where you plan to create the static site. Required. |
|
static_sites_workflow_preview_request
Required
|
A JSON representation of the StaticSitesWorkflowPreviewRequest properties. See example. Is either a StaticSitesWorkflowPreviewRequest type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSitesWorkflowPreview or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
reset_properties_envelope
Required
|
Is either a StaticSiteResetPropertiesARMResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.StaticSiteARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site to create or update. Required. |
|
static_site_envelope
Required
|
A JSON representation of the staticsite properties. See example. Is either a StaticSitePatchResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.StaticSiteUserARMResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the static site. Required. |
|
authprovider
Required
|
The auth provider for this user. Required. |
|
userid
Required
|
The user id of the user. Required. |
|
static_site_user_envelope
Required
|
A JSON representation of the StaticSiteUser properties. See example. Is either a StaticSiteUserARMResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
StaticSiteUserARMResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.web.v2021_01_15.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2021_01_15\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for