StaticSitesOperations Class
StaticSitesOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectStaticSitesOperations
Constructor
StaticSitesOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| 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. |
| 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_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. |
| 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_static_site |
Deletes a static site. Description for Deletes a static site. |
| delete_static_site_build |
Deletes a static site build. Description for Deletes a static site build. |
| delete_static_site_custom_domain |
Deletes a custom domain. Description for Deletes a custom domain. |
| delete_static_site_user |
Deletes the user entry from the static site. Description for Deletes the user entry from the static site. |
| detach_static_site |
Detaches a static site. Description for Detaches a static site. |
| 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_sites_by_resource_group |
Gets all static sites in the specified resource group. Description for Gets all static sites in the specified resource group. |
| list |
Get all Static Sites for a subscription. Description for Get all Static Sites for a subscription. |
| list_static_site_build_function_app_settings |
Gets the application settings of a static site. Description for Gets the application settings of a static site. |
| 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_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. |
| 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. |
| 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. |
| 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_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.
async create_or_update_static_site(resource_group_name: str, name: str, static_site_envelope: azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteARMResource, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteARMResourceParameters
- static_site_envelope
- StaticSiteARMResource
A JSON representation of the staticsite properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteARMResource, or the result of cls(response)
Return type
Exceptions
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.
async create_or_update_static_site_build_function_app_settings(resource_group_name: str, name: str, pr_id: str, app_settings: azure.mgmt.web.v2019_08_01.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StringDictionaryParameters
- app_settings
- StringDictionary
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StringDictionary, or the result of cls(response)
Return type
Exceptions
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.
async create_or_update_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteCustomDomainOverviewARMResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteCustomDomainOverviewARMResource, or the result of cls(response)
Return type
Exceptions
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.
async create_or_update_static_site_function_app_settings(resource_group_name: str, name: str, app_settings: azure.mgmt.web.v2019_08_01.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StringDictionaryParameters
- app_settings
- StringDictionary
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StringDictionary, or the result of cls(response)
Return type
Exceptions
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.
async create_user_roles_invitation_link(resource_group_name: str, name: str, static_site_user_roles_invitation_envelope: azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteUserInvitationRequestResource, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteUserInvitationResponseResourceParameters
- static_site_user_roles_invitation_envelope
- StaticSiteUserInvitationRequestResource
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteUserInvitationResponseResource, or the result of cls(response)
Return type
Exceptions
delete_static_site
Deletes a static site.
Description for Deletes a static site.
async delete_static_site(resource_group_name: str, name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
delete_static_site_build
Deletes a static site build.
Description for Deletes a static site build.
async delete_static_site_build(resource_group_name: str, name: str, pr_id: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
delete_static_site_custom_domain
Deletes a custom domain.
Description for Deletes a custom domain.
async delete_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
delete_static_site_user
Deletes the user entry from the static site.
Description for Deletes the user entry from the static site.
async delete_static_site_user(resource_group_name: str, name: str, authprovider: str, userid: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
detach_static_site
Detaches a static site.
Description for Detaches a static site.
async detach_static_site(resource_group_name: str, name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get_static_site
Gets the details of a static site.
Description for Gets the details of a static site.
async get_static_site(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteARMResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteARMResource, or the result of cls(response)
Return type
Exceptions
get_static_site_build
Gets the details of a static site build.
Description for Gets the details of a static site build.
async get_static_site_build(resource_group_name: str, name: str, pr_id: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteBuildARMResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteBuildARMResource, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteBuildCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteBuildCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteCollection or the result of cls(response)
Return type
Exceptions
list
Get all Static Sites for a subscription.
Description for Get all Static Sites for a subscription.
list(**kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteCollection or the result of cls(response)
Return type
Exceptions
list_static_site_build_function_app_settings
Gets the application settings of a static site.
Description for Gets the application settings of a static site.
async list_static_site_build_function_app_settings(resource_group_name: str, name: str, pr_id: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StringDictionaryParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StringDictionary, or the result of cls(response)
Return type
Exceptions
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, pr_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteFunctionOverviewCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteFunctionOverviewCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteCustomDomainOverviewCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteCustomDomainOverviewCollection or the result of cls(response)
Return type
Exceptions
list_static_site_function_app_settings
Gets the application settings of a static site.
Description for Gets the application settings of a static site.
async list_static_site_function_app_settings(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StringDictionaryParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StringDictionary, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteFunctionOverviewCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteFunctionOverviewCollection or the result of cls(response)
Return type
Exceptions
list_static_site_secrets
Lists the secrets for an existing static site.
Description for Lists the secrets for an existing static site.
async list_static_site_secrets(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StringDictionaryParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StringDictionary, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteUserCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteUserCollection or the result of cls(response)
Return type
Exceptions
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.
async reset_static_site_api_key(resource_group_name: str, name: str, reset_properties_envelope: azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteResetPropertiesARMResource, **kwargs: Any) -> NoneParameters
- reset_properties_envelope
- StaticSiteResetPropertiesARMResource
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
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.
async update_static_site(resource_group_name: str, name: str, static_site_envelope: azure.mgmt.web.v2019_08_01.models._models_py3.StaticSitePatchResource, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteARMResourceParameters
- static_site_envelope
- StaticSitePatchResource
A JSON representation of the staticsite properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteARMResource, or the result of cls(response)
Return type
Exceptions
update_static_site_user
Updates a user entry with the listed roles.
Description for Updates a user entry with the listed roles.
async update_static_site_user(resource_group_name: str, name: str, authprovider: str, userid: str, static_site_user_envelope: azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteUserARMResource, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.StaticSiteUserARMResourceParameters
- static_site_user_envelope
- StaticSiteUserARMResource
A JSON representation of the StaticSiteUser properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteUserARMResource, or the result of cls(response)
Return type
Exceptions
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.
async validate_custom_domain_can_be_added_to_static_site(resource_group_name: str, name: str, domain_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.web.v2019_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2019_08_01\\models\\__init__.py'>Feedback
Submit and view feedback for