StaticSitesOperations Class

StaticSitesOperations 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.object
StaticSitesOperations

Constructor

StaticSitesOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

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.

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.

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.

create_or_update_static_site(resource_group_name, name, static_site_envelope, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site to create or update.

static_site_envelope
StaticSiteARMResource
Required

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

create_or_update_static_site_build_function_app_settings

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

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

create_or_update_static_site_build_function_app_settings(resource_group_name, name, pr_id, app_settings, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

pr_id
str
Required

The stage site identifier.

app_settings
StringDictionary
Required
cls
callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

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_custom_domain(resource_group_name, name, domain_name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

domain_name
str
Required

The custom domain to create.

cls
callable

A custom type or function that will be passed the direct response

Returns

StaticSiteCustomDomainOverviewARMResource, or the result of cls(response)

Return type

create_or_update_static_site_function_app_settings

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

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

create_or_update_static_site_function_app_settings(resource_group_name, name, app_settings, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

app_settings
StringDictionary
Required
cls
callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

Creates an invitation link for a user with the role.

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

create_user_roles_invitation_link(resource_group_name, name, static_site_user_roles_invitation_envelope, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

static_site_user_roles_invitation_envelope
StaticSiteUserInvitationRequestResource
Required
cls
callable

A custom type or function that will be passed the direct response

Returns

StaticSiteUserInvitationResponseResource, or the result of cls(response)

Return type

delete_static_site

Deletes a static site.

Description for Deletes a static site.

delete_static_site(resource_group_name, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site to delete.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

delete_static_site_build

Deletes a static site build.

Description for Deletes a static site build.

delete_static_site_build(resource_group_name, name, pr_id, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

pr_id
str
Required

The stage site identifier.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

delete_static_site_custom_domain

Deletes a custom domain.

Description for Deletes a custom domain.

delete_static_site_custom_domain(resource_group_name, name, domain_name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

domain_name
str
Required

The custom domain to delete.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

delete_static_site_user

Deletes the user entry from the static site.

Description for Deletes the user entry from the static site.

delete_static_site_user(resource_group_name, name, authprovider, userid, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the staticsite.

authprovider
str
Required

The auth provider for this user.

userid
str
Required

The user id of the user.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

detach_static_site

Detaches a static site.

Description for Detaches a static site.

detach_static_site(resource_group_name, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site to detach.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

get_static_site

Gets the details of a static site.

Description for Gets the details of a static site.

get_static_site(resource_group_name, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

cls
callable

A custom type or function that will be passed the direct response

Returns

StaticSiteARMResource, or the result of cls(response)

Return type

get_static_site_build

Gets the details of a static site build.

Description for Gets the details of a static site build.

get_static_site_build(resource_group_name, name, pr_id, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

pr_id
str
Required

The stage site identifier.

cls
callable

A custom type or function that will be passed the direct response

Returns

StaticSiteBuildARMResource, or the result of cls(response)

Return type

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, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

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

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, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

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

list

Get all Static Sites for a subscription.

Description for Get all Static Sites for a subscription.

list(**kwargs)

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

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_function_app_settings(resource_group_name, name, pr_id, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

pr_id
str
Required

The stage site identifier.

cls
callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

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, name, pr_id, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

pr_id
str
Required

The stage site identifier.

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

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, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site resource to search in.

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

list_static_site_function_app_settings

Gets the application settings of a static site.

Description for Gets the application settings of a static site.

list_static_site_function_app_settings(resource_group_name, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

cls
callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

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, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

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

list_static_site_secrets

Lists the secrets for an existing static site.

Description for Lists the secrets for an existing static site.

list_static_site_secrets(resource_group_name, name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

cls
callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

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, name, authprovider, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

authprovider
str
Required

The auth provider for the users.

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

preview_workflow

Generates a preview workflow file for the static site.

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

preview_workflow(location, static_sites_workflow_preview_request, **kwargs)

Parameters

location
str
Required

Location where you plan to create the static site.

static_sites_workflow_preview_request
StaticSitesWorkflowPreviewRequest
Required

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

reset_static_site_api_key

Resets the api key for an existing static site.

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

reset_static_site_api_key(resource_group_name, name, reset_properties_envelope, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

reset_properties_envelope
StaticSiteResetPropertiesARMResource
Required
cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

update_static_site

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

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

update_static_site(resource_group_name, name, static_site_envelope, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site to create or update.

static_site_envelope
StaticSitePatchResource
Required

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

update_static_site_user

Updates a user entry with the listed roles.

Description for Updates a user entry with the listed roles.

update_static_site_user(resource_group_name, name, authprovider, userid, static_site_user_envelope, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

authprovider
str
Required

The auth provider for this user.

userid
str
Required

The user id of the user.

static_site_user_envelope
StaticSiteUserARMResource
Required

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

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.

validate_custom_domain_can_be_added_to_static_site(resource_group_name, name, domain_name, **kwargs)

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the static site.

domain_name
str
Required

The custom domain to validate.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Attributes

models

models = <module 'azure.mgmt.web.v2020_09_01.models' from 'c:\\hostedtoolcache\\windows\\python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2020_09_01\\models\\__init__.py'>