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
| 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_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_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_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_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_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_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. |
| 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.
async begin_approve_or_reject_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkConnectionApprovalRequestResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResource]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response)
Return type
Exceptions
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.
async begin_create_or_update_static_site(resource_group_name: str, name: str, static_site_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteARMResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteARMResource]Parameters
- 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
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either StaticSiteARMResource or the result of cls(response)
Return type
Exceptions
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.
async begin_create_or_update_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, static_site_custom_domain_request_properties_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteCustomDomainRequestPropertiesARMResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteCustomDomainOverviewARMResource]Parameters
- static_site_custom_domain_request_properties_envelope
- StaticSiteCustomDomainRequestPropertiesARMResource
A JSON representation of the static site custom domain request properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either StaticSiteCustomDomainOverviewARMResource or the result of cls(response)
Return type
Exceptions
begin_create_zip_deployment_for_static_site
Deploys zipped content to a static site.
Description for Deploys zipped content to a static site.
async begin_create_zip_deployment_for_static_site(resource_group_name: str, name: str, static_site_zip_deployment_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteZipDeploymentARMResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- static_site_zip_deployment_envelope
- StaticSiteZipDeploymentARMResource
A JSON representation of the StaticSiteZipDeployment properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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.
async begin_create_zip_deployment_for_static_site_build(resource_group_name: str, name: str, environment_name: str, static_site_zip_deployment_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteZipDeploymentARMResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- static_site_zip_deployment_envelope
- StaticSiteZipDeploymentARMResource
A JSON representation of the StaticSiteZipDeployment properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_delete_private_endpoint_connection
Deletes a private endpoint connection.
Description for Deletes a private endpoint connection.
async begin_delete_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[Any]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either any or the result of cls(response)
Return type
Exceptions
begin_delete_static_site
Deletes a static site.
Description for Deletes a static site.
async begin_delete_static_site(resource_group_name: str, name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_delete_static_site_build
Deletes a static site build.
Description for Deletes a static site build.
async begin_delete_static_site_build(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_delete_static_site_custom_domain
Deletes a custom domain.
Description for Deletes a custom domain.
async begin_delete_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_detach_static_site
Detaches a static site.
Description for Detaches a static site.
async begin_detach_static_site(resource_group_name: str, name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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.
async 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: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppARMResource, is_forced: Optional[bool] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppARMResource]Parameters
- static_site_user_provided_function_envelope
- StaticSiteUserProvidedFunctionAppARMResource
A JSON representation of the user provided function app properties. See example.
- is_forced
- 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>.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)
Return type
Exceptions
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.
async 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: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppARMResource, is_forced: Optional[bool] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppARMResource]Parameters
- static_site_user_provided_function_envelope
- StaticSiteUserProvidedFunctionAppARMResource
A JSON representation of the user provided function app properties. See example.
- is_forced
- 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>.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either StaticSiteUserProvidedFunctionAppARMResource or the result of cls(response)
Return type
Exceptions
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.
async 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: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteCustomDomainRequestPropertiesARMResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- static_site_custom_domain_request_properties_envelope
- StaticSiteCustomDomainRequestPropertiesARMResource
A JSON representation of the static site custom domain request properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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.
async create_or_update_static_site_app_settings(resource_group_name: str, name: str, app_settings: azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionaryParameters
- app_settings
- StringDictionary
The dictionary containing the static site app settings to update.
- 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_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.
async create_or_update_static_site_build_app_settings(resource_group_name: str, name: str, environment_name: str, app_settings: azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionaryParameters
- app_settings
- StringDictionary
The dictionary containing the static site app settings to update.
- 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_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, environment_name: str, app_settings: azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionaryParameters
- app_settings
- StringDictionary
The dictionary containing the static site function app settings to update.
- 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_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.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionaryParameters
- app_settings
- StringDictionary
The dictionary containing the static site function app settings to update.
- 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.v2021_01_15.models._models_py3.StaticSiteUserInvitationRequestResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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_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_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.
async detach_user_provided_function_app_from_static_site(resource_group_name: str, name: str, function_app_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
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.
async 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
- 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_private_endpoint_connection
Gets a private endpoint connection.
Description for Gets a private endpoint connection.
async get_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RemotePrivateEndpointConnectionARMResource, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PrivateEndpointConnectionCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either PrivateEndpointConnectionCollection or the result of cls(response)
Return type
Exceptions
get_private_link_resources
Gets the private link resources.
Description for Gets the private link resources.
async get_private_link_resources(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkResourcesWrapperParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PrivateLinkResourcesWrapper, 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.v2021_01_15.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, environment_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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.v2021_01_15.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_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.
async get_static_site_custom_domain(resource_group_name: str, name: str, domain_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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
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.v2021_01_15.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
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.
async get_user_provided_function_app_for_static_site(resource_group_name: str, name: str, function_app_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppARMResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteUserProvidedFunctionAppARMResource, or the result of cls(response)
Return type
Exceptions
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.
async get_user_provided_function_app_for_static_site_build(resource_group_name: str, name: str, environment_name: str, function_app_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppARMResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSiteUserProvidedFunctionAppARMResource, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppsCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteUserProvidedFunctionAppsCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.StaticSiteUserProvidedFunctionAppsCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StaticSiteUserProvidedFunctionAppsCollection 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.v2021_01_15.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_app_settings
Gets the application settings of a static site.
Description for Gets the application settings of a static site.
async list_static_site_app_settings(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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_app_settings
Gets the application settings of a static site build.
Description for Gets the application settings of a static site build.
async list_static_site_build_app_settings(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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_function_app_settings
Gets the application settings of a static site build.
Description for Gets the application settings of a static site build.
async list_static_site_build_function_app_settings(resource_group_name: str, name: str, environment_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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, environment_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.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_configured_roles
Lists the roles configured for the static site.
Description for Lists the roles configured for the static site.
async list_static_site_configured_roles(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringListParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StringList, 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.v2021_01_15.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.v2021_01_15.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.v2021_01_15.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.v2021_01_15.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.v2021_01_15.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
preview_workflow
Generates a preview workflow file for the static site.
Description for Generates a preview workflow file for the static site.
async preview_workflow(location: str, static_sites_workflow_preview_request: azure.mgmt.web.v2021_01_15.models._models_py3.StaticSitesWorkflowPreviewRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StaticSitesWorkflowPreviewParameters
- static_sites_workflow_preview_request
- StaticSitesWorkflowPreviewRequest
A JSON representation of the StaticSitesWorkflowPreviewRequest properties. See example.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StaticSitesWorkflowPreview, 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.v2021_01_15.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.v2021_01_15.models._models_py3.StaticSitePatchResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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.v2021_01_15.models._models_py3.StaticSiteUserARMResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.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
Attributes
models
models = <module 'azure.mgmt.web.v2021_01_15.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2021_01_15\\models\\__init__.py'>Feedback
Submit and view feedback for