StaticSites interface
Interface representing a StaticSites.
Methods
Method Details
beginApproveOrRejectPrivateEndpointConnection(string, string, string, RemotePrivateEndpointConnectionARMResource, StaticSitesApproveOrRejectPrivateEndpointConnectionOptionalParams)
Description for Approves or rejects a private endpoint connection
function beginApproveOrRejectPrivateEndpointConnection(resourceGroupName: string, name: string, privateEndpointConnectionName: string, privateEndpointWrapper: RemotePrivateEndpointConnectionARMResource, options?: StaticSitesApproveOrRejectPrivateEndpointConnectionOptionalParams): Promise<SimplePollerLike<OperationState<RemotePrivateEndpointConnectionARMResource>, RemotePrivateEndpointConnectionARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- privateEndpointConnectionName
-
string
Name of the private endpoint connection.
- privateEndpointWrapper
- RemotePrivateEndpointConnectionARMResource
Request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RemotePrivateEndpointConnectionARMResource>, RemotePrivateEndpointConnectionARMResource>>
beginApproveOrRejectPrivateEndpointConnectionAndWait(string, string, string, RemotePrivateEndpointConnectionARMResource, StaticSitesApproveOrRejectPrivateEndpointConnectionOptionalParams)
Description for Approves or rejects a private endpoint connection
function beginApproveOrRejectPrivateEndpointConnectionAndWait(resourceGroupName: string, name: string, privateEndpointConnectionName: string, privateEndpointWrapper: RemotePrivateEndpointConnectionARMResource, options?: StaticSitesApproveOrRejectPrivateEndpointConnectionOptionalParams): Promise<RemotePrivateEndpointConnectionARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- privateEndpointConnectionName
-
string
Name of the private endpoint connection.
- privateEndpointWrapper
- RemotePrivateEndpointConnectionARMResource
Request body.
The options parameters.
Returns
beginCreateOrUpdateStaticSite(string, string, StaticSiteARMResource, StaticSitesCreateOrUpdateStaticSiteOptionalParams)
Description for Creates a new static site in an existing resource group, or updates an existing static site.
function beginCreateOrUpdateStaticSite(resourceGroupName: string, name: string, staticSiteEnvelope: StaticSiteARMResource, options?: StaticSitesCreateOrUpdateStaticSiteOptionalParams): Promise<SimplePollerLike<OperationState<StaticSiteARMResource>, StaticSiteARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site to create or update.
- staticSiteEnvelope
- StaticSiteARMResource
A JSON representation of the staticsite properties. See example.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StaticSiteARMResource>, StaticSiteARMResource>>
beginCreateOrUpdateStaticSiteAndWait(string, string, StaticSiteARMResource, StaticSitesCreateOrUpdateStaticSiteOptionalParams)
Description for Creates a new static site in an existing resource group, or updates an existing static site.
function beginCreateOrUpdateStaticSiteAndWait(resourceGroupName: string, name: string, staticSiteEnvelope: StaticSiteARMResource, options?: StaticSitesCreateOrUpdateStaticSiteOptionalParams): Promise<StaticSiteARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site to create or update.
- staticSiteEnvelope
- StaticSiteARMResource
A JSON representation of the staticsite properties. See example.
The options parameters.
Returns
Promise<StaticSiteARMResource>
beginCreateOrUpdateStaticSiteCustomDomain(string, string, string, StaticSiteCustomDomainRequestPropertiesARMResource, StaticSitesCreateOrUpdateStaticSiteCustomDomainOptionalParams)
Description for Creates a new static site custom domain in an existing resource group and static site.
function beginCreateOrUpdateStaticSiteCustomDomain(resourceGroupName: string, name: string, domainName: string, staticSiteCustomDomainRequestPropertiesEnvelope: StaticSiteCustomDomainRequestPropertiesARMResource, options?: StaticSitesCreateOrUpdateStaticSiteCustomDomainOptionalParams): Promise<SimplePollerLike<OperationState<StaticSiteCustomDomainOverviewARMResource>, StaticSiteCustomDomainOverviewARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- domainName
-
string
The custom domain to create.
- staticSiteCustomDomainRequestPropertiesEnvelope
- StaticSiteCustomDomainRequestPropertiesARMResource
A JSON representation of the static site custom domain request properties. See example.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StaticSiteCustomDomainOverviewARMResource>, StaticSiteCustomDomainOverviewARMResource>>
beginCreateOrUpdateStaticSiteCustomDomainAndWait(string, string, string, StaticSiteCustomDomainRequestPropertiesARMResource, StaticSitesCreateOrUpdateStaticSiteCustomDomainOptionalParams)
Description for Creates a new static site custom domain in an existing resource group and static site.
function beginCreateOrUpdateStaticSiteCustomDomainAndWait(resourceGroupName: string, name: string, domainName: string, staticSiteCustomDomainRequestPropertiesEnvelope: StaticSiteCustomDomainRequestPropertiesARMResource, options?: StaticSitesCreateOrUpdateStaticSiteCustomDomainOptionalParams): Promise<StaticSiteCustomDomainOverviewARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- domainName
-
string
The custom domain to create.
- staticSiteCustomDomainRequestPropertiesEnvelope
- StaticSiteCustomDomainRequestPropertiesARMResource
A JSON representation of the static site custom domain request properties. See example.
The options parameters.
Returns
beginCreateZipDeploymentForStaticSite(string, string, StaticSiteZipDeploymentARMResource, StaticSitesCreateZipDeploymentForStaticSiteOptionalParams)
Description for Deploys zipped content to a static site.
function beginCreateZipDeploymentForStaticSite(resourceGroupName: string, name: string, staticSiteZipDeploymentEnvelope: StaticSiteZipDeploymentARMResource, options?: StaticSitesCreateZipDeploymentForStaticSiteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- staticSiteZipDeploymentEnvelope
- StaticSiteZipDeploymentARMResource
A JSON representation of the StaticSiteZipDeployment properties. See example.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginCreateZipDeploymentForStaticSiteAndWait(string, string, StaticSiteZipDeploymentARMResource, StaticSitesCreateZipDeploymentForStaticSiteOptionalParams)
Description for Deploys zipped content to a static site.
function beginCreateZipDeploymentForStaticSiteAndWait(resourceGroupName: string, name: string, staticSiteZipDeploymentEnvelope: StaticSiteZipDeploymentARMResource, options?: StaticSitesCreateZipDeploymentForStaticSiteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- staticSiteZipDeploymentEnvelope
- StaticSiteZipDeploymentARMResource
A JSON representation of the StaticSiteZipDeployment properties. See example.
The options parameters.
Returns
Promise<void>
beginCreateZipDeploymentForStaticSiteBuild(string, string, string, StaticSiteZipDeploymentARMResource, StaticSitesCreateZipDeploymentForStaticSiteBuildOptionalParams)
Description for Deploys zipped content to a specific environment of a static site.
function beginCreateZipDeploymentForStaticSiteBuild(resourceGroupName: string, name: string, environmentName: string, staticSiteZipDeploymentEnvelope: StaticSiteZipDeploymentARMResource, options?: StaticSitesCreateZipDeploymentForStaticSiteBuildOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
Name of the environment.
- staticSiteZipDeploymentEnvelope
- StaticSiteZipDeploymentARMResource
A JSON representation of the StaticSiteZipDeployment properties. See example.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginCreateZipDeploymentForStaticSiteBuildAndWait(string, string, string, StaticSiteZipDeploymentARMResource, StaticSitesCreateZipDeploymentForStaticSiteBuildOptionalParams)
Description for Deploys zipped content to a specific environment of a static site.
function beginCreateZipDeploymentForStaticSiteBuildAndWait(resourceGroupName: string, name: string, environmentName: string, staticSiteZipDeploymentEnvelope: StaticSiteZipDeploymentARMResource, options?: StaticSitesCreateZipDeploymentForStaticSiteBuildOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
Name of the environment.
- staticSiteZipDeploymentEnvelope
- StaticSiteZipDeploymentARMResource
A JSON representation of the StaticSiteZipDeployment properties. See example.
The options parameters.
Returns
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, StaticSitesDeletePrivateEndpointConnectionOptionalParams)
Description for Deletes a private endpoint connection
function beginDeletePrivateEndpointConnection(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: StaticSitesDeletePrivateEndpointConnectionOptionalParams): Promise<SimplePollerLike<OperationState<StaticSitesDeletePrivateEndpointConnectionResponse>, StaticSitesDeletePrivateEndpointConnectionResponse>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- privateEndpointConnectionName
-
string
Name of the private endpoint connection.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StaticSitesDeletePrivateEndpointConnectionResponse>, StaticSitesDeletePrivateEndpointConnectionResponse>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, StaticSitesDeletePrivateEndpointConnectionOptionalParams)
Description for Deletes a private endpoint connection
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: StaticSitesDeletePrivateEndpointConnectionOptionalParams): Promise<StaticSitesDeletePrivateEndpointConnectionResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- privateEndpointConnectionName
-
string
Name of the private endpoint connection.
The options parameters.
Returns
beginDeleteStaticSite(string, string, StaticSitesDeleteStaticSiteOptionalParams)
Description for Deletes a static site.
function beginDeleteStaticSite(resourceGroupName: string, name: string, options?: StaticSitesDeleteStaticSiteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site to delete.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteStaticSiteAndWait(string, string, StaticSitesDeleteStaticSiteOptionalParams)
Description for Deletes a static site.
function beginDeleteStaticSiteAndWait(resourceGroupName: string, name: string, options?: StaticSitesDeleteStaticSiteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site to delete.
The options parameters.
Returns
Promise<void>
beginDeleteStaticSiteBuild(string, string, string, StaticSitesDeleteStaticSiteBuildOptionalParams)
Description for Deletes a static site build.
function beginDeleteStaticSiteBuild(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesDeleteStaticSiteBuildOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteStaticSiteBuildAndWait(string, string, string, StaticSitesDeleteStaticSiteBuildOptionalParams)
Description for Deletes a static site build.
function beginDeleteStaticSiteBuildAndWait(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesDeleteStaticSiteBuildOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
Promise<void>
beginDeleteStaticSiteCustomDomain(string, string, string, StaticSitesDeleteStaticSiteCustomDomainOptionalParams)
Description for Deletes a custom domain.
function beginDeleteStaticSiteCustomDomain(resourceGroupName: string, name: string, domainName: string, options?: StaticSitesDeleteStaticSiteCustomDomainOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- domainName
-
string
The custom domain to delete.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteStaticSiteCustomDomainAndWait(string, string, string, StaticSitesDeleteStaticSiteCustomDomainOptionalParams)
Description for Deletes a custom domain.
function beginDeleteStaticSiteCustomDomainAndWait(resourceGroupName: string, name: string, domainName: string, options?: StaticSitesDeleteStaticSiteCustomDomainOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- domainName
-
string
The custom domain to delete.
The options parameters.
Returns
Promise<void>
beginDetachStaticSite(string, string, StaticSitesDetachStaticSiteOptionalParams)
Description for Detaches a static site.
function beginDetachStaticSite(resourceGroupName: string, name: string, options?: StaticSitesDetachStaticSiteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site to detach.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDetachStaticSiteAndWait(string, string, StaticSitesDetachStaticSiteOptionalParams)
Description for Detaches a static site.
function beginDetachStaticSiteAndWait(resourceGroupName: string, name: string, options?: StaticSitesDetachStaticSiteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site to detach.
The options parameters.
Returns
Promise<void>
beginLinkBackend(string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesLinkBackendOptionalParams)
Link backend to a static site
function beginLinkBackend(resourceGroupName: string, name: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesLinkBackendOptionalParams): Promise<SimplePollerLike<OperationState<StaticSiteLinkedBackendARMResource>, StaticSiteLinkedBackendARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- linkedBackendName
-
string
Name of the backend to link to the static site
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StaticSiteLinkedBackendARMResource>, StaticSiteLinkedBackendARMResource>>
beginLinkBackendAndWait(string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesLinkBackendOptionalParams)
Link backend to a static site
function beginLinkBackendAndWait(resourceGroupName: string, name: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesLinkBackendOptionalParams): Promise<StaticSiteLinkedBackendARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- linkedBackendName
-
string
Name of the backend to link to the static site
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<StaticSiteLinkedBackendARMResource>
beginLinkBackendToBuild(string, string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesLinkBackendToBuildOptionalParams)
Link backend to a static site build
function beginLinkBackendToBuild(resourceGroupName: string, name: string, environmentName: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesLinkBackendToBuildOptionalParams): Promise<SimplePollerLike<OperationState<StaticSiteLinkedBackendARMResource>, StaticSiteLinkedBackendARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier
- linkedBackendName
-
string
Name of the backend to link to the static site
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StaticSiteLinkedBackendARMResource>, StaticSiteLinkedBackendARMResource>>
beginLinkBackendToBuildAndWait(string, string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesLinkBackendToBuildOptionalParams)
Link backend to a static site build
function beginLinkBackendToBuildAndWait(resourceGroupName: string, name: string, environmentName: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesLinkBackendToBuildOptionalParams): Promise<StaticSiteLinkedBackendARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier
- linkedBackendName
-
string
Name of the backend to link to the static site
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<StaticSiteLinkedBackendARMResource>
beginRegisterUserProvidedFunctionAppWithStaticSite(string, string, string, StaticSiteUserProvidedFunctionAppARMResource, StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams)
Description for Register a user provided function app with a static site
function beginRegisterUserProvidedFunctionAppWithStaticSite(resourceGroupName: string, name: string, functionAppName: string, staticSiteUserProvidedFunctionEnvelope: StaticSiteUserProvidedFunctionAppARMResource, options?: StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams): Promise<SimplePollerLike<OperationState<StaticSiteUserProvidedFunctionAppARMResource>, StaticSiteUserProvidedFunctionAppARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- functionAppName
-
string
Name of the function app to register with the static site.
- staticSiteUserProvidedFunctionEnvelope
- StaticSiteUserProvidedFunctionAppARMResource
A JSON representation of the user provided function app properties. See example.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StaticSiteUserProvidedFunctionAppARMResource>, StaticSiteUserProvidedFunctionAppARMResource>>
beginRegisterUserProvidedFunctionAppWithStaticSiteAndWait(string, string, string, StaticSiteUserProvidedFunctionAppARMResource, StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams)
Description for Register a user provided function app with a static site
function beginRegisterUserProvidedFunctionAppWithStaticSiteAndWait(resourceGroupName: string, name: string, functionAppName: string, staticSiteUserProvidedFunctionEnvelope: StaticSiteUserProvidedFunctionAppARMResource, options?: StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams): Promise<StaticSiteUserProvidedFunctionAppARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- functionAppName
-
string
Name of the function app to register with the static site.
- staticSiteUserProvidedFunctionEnvelope
- StaticSiteUserProvidedFunctionAppARMResource
A JSON representation of the user provided function app properties. See example.
The options parameters.
Returns
beginRegisterUserProvidedFunctionAppWithStaticSiteBuild(string, string, string, string, StaticSiteUserProvidedFunctionAppARMResource, StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams)
Description for Register a user provided function app with a static site build
function beginRegisterUserProvidedFunctionAppWithStaticSiteBuild(resourceGroupName: string, name: string, environmentName: string, functionAppName: string, staticSiteUserProvidedFunctionEnvelope: StaticSiteUserProvidedFunctionAppARMResource, options?: StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams): Promise<SimplePollerLike<OperationState<StaticSiteUserProvidedFunctionAppARMResource>, StaticSiteUserProvidedFunctionAppARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
- functionAppName
-
string
Name of the function app to register with the static site build.
- staticSiteUserProvidedFunctionEnvelope
- StaticSiteUserProvidedFunctionAppARMResource
A JSON representation of the user provided function app properties. See example.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StaticSiteUserProvidedFunctionAppARMResource>, StaticSiteUserProvidedFunctionAppARMResource>>
beginRegisterUserProvidedFunctionAppWithStaticSiteBuildAndWait(string, string, string, string, StaticSiteUserProvidedFunctionAppARMResource, StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams)
Description for Register a user provided function app with a static site build
function beginRegisterUserProvidedFunctionAppWithStaticSiteBuildAndWait(resourceGroupName: string, name: string, environmentName: string, functionAppName: string, staticSiteUserProvidedFunctionEnvelope: StaticSiteUserProvidedFunctionAppARMResource, options?: StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams): Promise<StaticSiteUserProvidedFunctionAppARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
- functionAppName
-
string
Name of the function app to register with the static site build.
- staticSiteUserProvidedFunctionEnvelope
- StaticSiteUserProvidedFunctionAppARMResource
A JSON representation of the user provided function app properties. See example.
The options parameters.
Returns
beginValidateBackend(string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesValidateBackendOptionalParams)
Validates that a backend can be linked to a static site
function beginValidateBackend(resourceGroupName: string, name: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesValidateBackendOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- linkedBackendName
-
string
Name of the linked backend that should be retrieved
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginValidateBackendAndWait(string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesValidateBackendOptionalParams)
Validates that a backend can be linked to a static site
function beginValidateBackendAndWait(resourceGroupName: string, name: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesValidateBackendOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- linkedBackendName
-
string
Name of the linked backend that should be retrieved
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<void>
beginValidateBackendForBuild(string, string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesValidateBackendForBuildOptionalParams)
Validates that a backend can be linked to a static site build
function beginValidateBackendForBuild(resourceGroupName: string, name: string, environmentName: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesValidateBackendForBuildOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier
- linkedBackendName
-
string
Name of the linked backend that should be retrieved
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginValidateBackendForBuildAndWait(string, string, string, string, StaticSiteLinkedBackendARMResource, StaticSitesValidateBackendForBuildOptionalParams)
Validates that a backend can be linked to a static site build
function beginValidateBackendForBuildAndWait(resourceGroupName: string, name: string, environmentName: string, linkedBackendName: string, staticSiteLinkedBackendEnvelope: StaticSiteLinkedBackendARMResource, options?: StaticSitesValidateBackendForBuildOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier
- linkedBackendName
-
string
Name of the linked backend that should be retrieved
- staticSiteLinkedBackendEnvelope
- StaticSiteLinkedBackendARMResource
A JSON representation of the linked backend request properties
The options parameters.
Returns
Promise<void>
beginValidateCustomDomainCanBeAddedToStaticSite(string, string, string, StaticSiteCustomDomainRequestPropertiesARMResource, StaticSitesValidateCustomDomainCanBeAddedToStaticSiteOptionalParams)
Description for Validates a particular custom domain can be added to a static site.
function beginValidateCustomDomainCanBeAddedToStaticSite(resourceGroupName: string, name: string, domainName: string, staticSiteCustomDomainRequestPropertiesEnvelope: StaticSiteCustomDomainRequestPropertiesARMResource, options?: StaticSitesValidateCustomDomainCanBeAddedToStaticSiteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- domainName
-
string
The custom domain to validate.
- staticSiteCustomDomainRequestPropertiesEnvelope
- StaticSiteCustomDomainRequestPropertiesARMResource
A JSON representation of the static site custom domain request properties. See example.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginValidateCustomDomainCanBeAddedToStaticSiteAndWait(string, string, string, StaticSiteCustomDomainRequestPropertiesARMResource, StaticSitesValidateCustomDomainCanBeAddedToStaticSiteOptionalParams)
Description for Validates a particular custom domain can be added to a static site.
function beginValidateCustomDomainCanBeAddedToStaticSiteAndWait(resourceGroupName: string, name: string, domainName: string, staticSiteCustomDomainRequestPropertiesEnvelope: StaticSiteCustomDomainRequestPropertiesARMResource, options?: StaticSitesValidateCustomDomainCanBeAddedToStaticSiteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- domainName
-
string
The custom domain to validate.
- staticSiteCustomDomainRequestPropertiesEnvelope
- StaticSiteCustomDomainRequestPropertiesARMResource
A JSON representation of the static site custom domain request properties. See example.
The options parameters.
Returns
Promise<void>
createOrUpdateBasicAuth(string, string, string, StaticSiteBasicAuthPropertiesARMResource, StaticSitesCreateOrUpdateBasicAuthOptionalParams)
Description for Adds or updates basic auth for a static site.
function createOrUpdateBasicAuth(resourceGroupName: string, name: string, basicAuthName: string, basicAuthEnvelope: StaticSiteBasicAuthPropertiesARMResource, options?: StaticSitesCreateOrUpdateBasicAuthOptionalParams): Promise<StaticSiteBasicAuthPropertiesARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- basicAuthName
-
string
name of the basic auth entry.
- basicAuthEnvelope
- StaticSiteBasicAuthPropertiesARMResource
A JSON representation of the basic auth properties.
The options parameters.
Returns
createOrUpdateBuildDatabaseConnection(string, string, string, string, DatabaseConnection, StaticSitesCreateOrUpdateBuildDatabaseConnectionOptionalParams)
Description for Create or update a database connection for a static site build
function createOrUpdateBuildDatabaseConnection(resourceGroupName: string, name: string, environmentName: string, databaseConnectionName: string, databaseConnectionRequestEnvelope: DatabaseConnection, options?: StaticSitesCreateOrUpdateBuildDatabaseConnectionOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier.
- databaseConnectionName
-
string
Name of the database connection.
- databaseConnectionRequestEnvelope
- DatabaseConnection
A JSON representation of the database connection request properties
The options parameters.
Returns
Promise<DatabaseConnection>
createOrUpdateDatabaseConnection(string, string, string, DatabaseConnection, StaticSitesCreateOrUpdateDatabaseConnectionOptionalParams)
Description for Create or update a database connection for a static site
function createOrUpdateDatabaseConnection(resourceGroupName: string, name: string, databaseConnectionName: string, databaseConnectionRequestEnvelope: DatabaseConnection, options?: StaticSitesCreateOrUpdateDatabaseConnectionOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- databaseConnectionName
-
string
Name of the database connection.
- databaseConnectionRequestEnvelope
- DatabaseConnection
A JSON representation of the database connection request properties
The options parameters.
Returns
Promise<DatabaseConnection>
createOrUpdateStaticSiteAppSettings(string, string, StringDictionary, StaticSitesCreateOrUpdateStaticSiteAppSettingsOptionalParams)
Description for Creates or updates the app settings of a static site.
function createOrUpdateStaticSiteAppSettings(resourceGroupName: string, name: string, appSettings: StringDictionary, options?: StaticSitesCreateOrUpdateStaticSiteAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- appSettings
- StringDictionary
The dictionary containing the static site app settings to update.
The options parameters.
Returns
Promise<StringDictionary>
createOrUpdateStaticSiteBuildAppSettings(string, string, string, StringDictionary, StaticSitesCreateOrUpdateStaticSiteBuildAppSettingsOptionalParams)
Description for Creates or updates the app settings of a static site build.
function createOrUpdateStaticSiteBuildAppSettings(resourceGroupName: string, name: string, environmentName: string, appSettings: StringDictionary, options?: StaticSitesCreateOrUpdateStaticSiteBuildAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
- appSettings
- StringDictionary
The dictionary containing the static site app settings to update.
The options parameters.
Returns
Promise<StringDictionary>
createOrUpdateStaticSiteBuildFunctionAppSettings(string, string, string, StringDictionary, StaticSitesCreateOrUpdateStaticSiteBuildFunctionAppSettingsOptionalParams)
Description for Creates or updates the function app settings of a static site build.
function createOrUpdateStaticSiteBuildFunctionAppSettings(resourceGroupName: string, name: string, environmentName: string, appSettings: StringDictionary, options?: StaticSitesCreateOrUpdateStaticSiteBuildFunctionAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
- appSettings
- StringDictionary
The dictionary containing the static site function app settings to update.
The options parameters.
Returns
Promise<StringDictionary>
createOrUpdateStaticSiteFunctionAppSettings(string, string, StringDictionary, StaticSitesCreateOrUpdateStaticSiteFunctionAppSettingsOptionalParams)
Description for Creates or updates the function app settings of a static site.
function createOrUpdateStaticSiteFunctionAppSettings(resourceGroupName: string, name: string, appSettings: StringDictionary, options?: StaticSitesCreateOrUpdateStaticSiteFunctionAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- appSettings
- StringDictionary
The dictionary containing the static site function app settings to update.
The options parameters.
Returns
Promise<StringDictionary>
createUserRolesInvitationLink(string, string, StaticSiteUserInvitationRequestResource, StaticSitesCreateUserRolesInvitationLinkOptionalParams)
Description for Creates an invitation link for a user with the role
function createUserRolesInvitationLink(resourceGroupName: string, name: string, staticSiteUserRolesInvitationEnvelope: StaticSiteUserInvitationRequestResource, options?: StaticSitesCreateUserRolesInvitationLinkOptionalParams): Promise<StaticSiteUserInvitationResponseResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- staticSiteUserRolesInvitationEnvelope
- StaticSiteUserInvitationRequestResource
Static sites user roles invitation resource.
The options parameters.
Returns
deleteBuildDatabaseConnection(string, string, string, string, StaticSitesDeleteBuildDatabaseConnectionOptionalParams)
Delete a database connection for a static site build
function deleteBuildDatabaseConnection(resourceGroupName: string, name: string, environmentName: string, databaseConnectionName: string, options?: StaticSitesDeleteBuildDatabaseConnectionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier.
- databaseConnectionName
-
string
Name of the database connection.
The options parameters.
Returns
Promise<void>
deleteDatabaseConnection(string, string, string, StaticSitesDeleteDatabaseConnectionOptionalParams)
Delete a database connection for a static site
function deleteDatabaseConnection(resourceGroupName: string, name: string, databaseConnectionName: string, options?: StaticSitesDeleteDatabaseConnectionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- databaseConnectionName
-
string
Name of the database connection.
The options parameters.
Returns
Promise<void>
deleteStaticSiteUser(string, string, string, string, StaticSitesDeleteStaticSiteUserOptionalParams)
Description for Deletes the user entry from the static site.
function deleteStaticSiteUser(resourceGroupName: string, name: string, authprovider: string, userid: string, options?: StaticSitesDeleteStaticSiteUserOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the staticsite.
- authprovider
-
string
The auth provider for this user.
- userid
-
string
The user id of the user.
The options parameters.
Returns
Promise<void>
detachUserProvidedFunctionAppFromStaticSite(string, string, string, StaticSitesDetachUserProvidedFunctionAppFromStaticSiteOptionalParams)
Description for Detach the user provided function app from the static site
function detachUserProvidedFunctionAppFromStaticSite(resourceGroupName: string, name: string, functionAppName: string, options?: StaticSitesDetachUserProvidedFunctionAppFromStaticSiteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- functionAppName
-
string
Name of the function app registered with the static site.
The options parameters.
Returns
Promise<void>
detachUserProvidedFunctionAppFromStaticSiteBuild(string, string, string, string, StaticSitesDetachUserProvidedFunctionAppFromStaticSiteBuildOptionalParams)
Description for Detach the user provided function app from the static site build
function detachUserProvidedFunctionAppFromStaticSiteBuild(resourceGroupName: string, name: string, environmentName: string, functionAppName: string, options?: StaticSitesDetachUserProvidedFunctionAppFromStaticSiteBuildOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
- functionAppName
-
string
Name of the function app registered with the static site build.
The options parameters.
Returns
Promise<void>
getBasicAuth(string, string, string, StaticSitesGetBasicAuthOptionalParams)
Description for Gets the basic auth properties for a static site.
function getBasicAuth(resourceGroupName: string, name: string, basicAuthName: string, options?: StaticSitesGetBasicAuthOptionalParams): Promise<StaticSiteBasicAuthPropertiesARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- basicAuthName
-
string
name of the basic auth entry.
The options parameters.
Returns
getBuildDatabaseConnection(string, string, string, string, StaticSitesGetBuildDatabaseConnectionOptionalParams)
Returns overview of a database connection for a static site build by name
function getBuildDatabaseConnection(resourceGroupName: string, name: string, environmentName: string, databaseConnectionName: string, options?: StaticSitesGetBuildDatabaseConnectionOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier.
- databaseConnectionName
-
string
Name of the database connection.
The options parameters.
Returns
Promise<DatabaseConnection>
getBuildDatabaseConnectionWithDetails(string, string, string, string, StaticSitesGetBuildDatabaseConnectionWithDetailsOptionalParams)
Returns details of a database connection for a static site build by name
function getBuildDatabaseConnectionWithDetails(resourceGroupName: string, name: string, environmentName: string, databaseConnectionName: string, options?: StaticSitesGetBuildDatabaseConnectionWithDetailsOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier.
- databaseConnectionName
-
string
Name of the database connection.
The options parameters.
Returns
Promise<DatabaseConnection>
getDatabaseConnection(string, string, string, StaticSitesGetDatabaseConnectionOptionalParams)
Returns overview of a database connection for a static site by name
function getDatabaseConnection(resourceGroupName: string, name: string, databaseConnectionName: string, options?: StaticSitesGetDatabaseConnectionOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- databaseConnectionName
-
string
Name of the database connection.
The options parameters.
Returns
Promise<DatabaseConnection>
getDatabaseConnectionWithDetails(string, string, string, StaticSitesGetDatabaseConnectionWithDetailsOptionalParams)
Returns details of a database connection for a static site by name
function getDatabaseConnectionWithDetails(resourceGroupName: string, name: string, databaseConnectionName: string, options?: StaticSitesGetDatabaseConnectionWithDetailsOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- databaseConnectionName
-
string
Name of the database connection.
The options parameters.
Returns
Promise<DatabaseConnection>
getLinkedBackend(string, string, string, StaticSitesGetLinkedBackendOptionalParams)
Returns the details of a linked backend linked to a static site by name
function getLinkedBackend(resourceGroupName: string, name: string, linkedBackendName: string, options?: StaticSitesGetLinkedBackendOptionalParams): Promise<StaticSiteLinkedBackendARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- linkedBackendName
-
string
Name of the linked backend that should be retrieved
The options parameters.
Returns
Promise<StaticSiteLinkedBackendARMResource>
getLinkedBackendForBuild(string, string, string, string, StaticSitesGetLinkedBackendForBuildOptionalParams)
Returns the details of a linked backend linked to a static site build by name
function getLinkedBackendForBuild(resourceGroupName: string, name: string, environmentName: string, linkedBackendName: string, options?: StaticSitesGetLinkedBackendForBuildOptionalParams): Promise<StaticSiteLinkedBackendARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier
- linkedBackendName
-
string
Name of the linked backend that should be retrieved
The options parameters.
Returns
Promise<StaticSiteLinkedBackendARMResource>
getPrivateEndpointConnection(string, string, string, StaticSitesGetPrivateEndpointConnectionOptionalParams)
Description for Gets a private endpoint connection
function getPrivateEndpointConnection(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: StaticSitesGetPrivateEndpointConnectionOptionalParams): Promise<RemotePrivateEndpointConnectionARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- privateEndpointConnectionName
-
string
Name of the private endpoint connection.
The options parameters.
Returns
getPrivateLinkResources(string, string, StaticSitesGetPrivateLinkResourcesOptionalParams)
Description for Gets the private link resources
function getPrivateLinkResources(resourceGroupName: string, name: string, options?: StaticSitesGetPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResourcesWrapper>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the site.
The options parameters.
Returns
Promise<PrivateLinkResourcesWrapper>
getStaticSite(string, string, StaticSitesGetStaticSiteOptionalParams)
Description for Gets the details of a static site.
function getStaticSite(resourceGroupName: string, name: string, options?: StaticSitesGetStaticSiteOptionalParams): Promise<StaticSiteARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
Promise<StaticSiteARMResource>
getStaticSiteBuild(string, string, string, StaticSitesGetStaticSiteBuildOptionalParams)
Description for Gets the details of a static site build.
function getStaticSiteBuild(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesGetStaticSiteBuildOptionalParams): Promise<StaticSiteBuildARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
Promise<StaticSiteBuildARMResource>
getStaticSiteCustomDomain(string, string, string, StaticSitesGetStaticSiteCustomDomainOptionalParams)
Description for Gets an existing custom domain for a particular static site.
function getStaticSiteCustomDomain(resourceGroupName: string, name: string, domainName: string, options?: StaticSitesGetStaticSiteCustomDomainOptionalParams): Promise<StaticSiteCustomDomainOverviewARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site resource to search in.
- domainName
-
string
The custom domain name.
The options parameters.
Returns
getUserProvidedFunctionAppForStaticSite(string, string, string, StaticSitesGetUserProvidedFunctionAppForStaticSiteOptionalParams)
Description for Gets the details of the user provided function app registered with a static site
function getUserProvidedFunctionAppForStaticSite(resourceGroupName: string, name: string, functionAppName: string, options?: StaticSitesGetUserProvidedFunctionAppForStaticSiteOptionalParams): Promise<StaticSiteUserProvidedFunctionAppARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- functionAppName
-
string
Name of the function app registered with the static site.
The options parameters.
Returns
getUserProvidedFunctionAppForStaticSiteBuild(string, string, string, string, StaticSitesGetUserProvidedFunctionAppForStaticSiteBuildOptionalParams)
Description for Gets the details of the user provided function app registered with a static site build
function getUserProvidedFunctionAppForStaticSiteBuild(resourceGroupName: string, name: string, environmentName: string, functionAppName: string, options?: StaticSitesGetUserProvidedFunctionAppForStaticSiteBuildOptionalParams): Promise<StaticSiteUserProvidedFunctionAppARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
- functionAppName
-
string
Name of the function app registered with the static site build.
The options parameters.
Returns
list(StaticSitesListOptionalParams)
Description for Get all Static Sites for a subscription.
function list(options?: StaticSitesListOptionalParams): PagedAsyncIterableIterator<StaticSiteARMResource, StaticSiteARMResource[], PageSettings>Parameters
- options
- StaticSitesListOptionalParams
The options parameters.
Returns
listBasicAuth(string, string, StaticSitesListBasicAuthOptionalParams)
Description for Gets the basic auth properties for a static site as a collection.
function listBasicAuth(resourceGroupName: string, name: string, options?: StaticSitesListBasicAuthOptionalParams): PagedAsyncIterableIterator<StaticSiteBasicAuthPropertiesARMResource, StaticSiteBasicAuthPropertiesARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
listBuildDatabaseConnections(string, string, string, StaticSitesGetBuildDatabaseConnectionsOptionalParams)
Returns overviews of database connections for a static site build
function listBuildDatabaseConnections(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesGetBuildDatabaseConnectionsOptionalParams): PagedAsyncIterableIterator<DatabaseConnection, DatabaseConnection[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
listBuildDatabaseConnectionsWithDetails(string, string, string, StaticSitesGetBuildDatabaseConnectionsWithDetailsOptionalParams)
Returns details of database connections for a static site build
function listBuildDatabaseConnectionsWithDetails(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesGetBuildDatabaseConnectionsWithDetailsOptionalParams): PagedAsyncIterableIterator<DatabaseConnection, DatabaseConnection[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
listDatabaseConnections(string, string, StaticSitesGetDatabaseConnectionsOptionalParams)
Returns overviews of database connections for a static site
function listDatabaseConnections(resourceGroupName: string, name: string, options?: StaticSitesGetDatabaseConnectionsOptionalParams): PagedAsyncIterableIterator<DatabaseConnection, DatabaseConnection[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
The options parameters.
Returns
listDatabaseConnectionsWithDetails(string, string, StaticSitesGetDatabaseConnectionsWithDetailsOptionalParams)
Returns details of database connections for a static site
function listDatabaseConnectionsWithDetails(resourceGroupName: string, name: string, options?: StaticSitesGetDatabaseConnectionsWithDetailsOptionalParams): PagedAsyncIterableIterator<DatabaseConnection, DatabaseConnection[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
The options parameters.
Returns
listLinkedBackends(string, string, StaticSitesGetLinkedBackendsOptionalParams)
Returns details of all backends linked to a static site
function listLinkedBackends(resourceGroupName: string, name: string, options?: StaticSitesGetLinkedBackendsOptionalParams): PagedAsyncIterableIterator<StaticSiteLinkedBackendARMResource, StaticSiteLinkedBackendARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
The options parameters.
Returns
listLinkedBackendsForBuild(string, string, string, StaticSitesGetLinkedBackendsForBuildOptionalParams)
Returns details of all backends linked to a static site build
function listLinkedBackendsForBuild(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesGetLinkedBackendsForBuildOptionalParams): PagedAsyncIterableIterator<StaticSiteLinkedBackendARMResource, StaticSiteLinkedBackendARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier
The options parameters.
Returns
listPrivateEndpointConnectionList(string, string, StaticSitesGetPrivateEndpointConnectionListOptionalParams)
Description for Gets the list of private endpoint connections associated with a static site
function listPrivateEndpointConnectionList(resourceGroupName: string, name: string, options?: StaticSitesGetPrivateEndpointConnectionListOptionalParams): PagedAsyncIterableIterator<RemotePrivateEndpointConnectionARMResource, RemotePrivateEndpointConnectionARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
listStaticSiteAppSettings(string, string, StaticSitesListStaticSiteAppSettingsOptionalParams)
Description for Gets the application settings of a static site.
function listStaticSiteAppSettings(resourceGroupName: string, name: string, options?: StaticSitesListStaticSiteAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
Promise<StringDictionary>
listStaticSiteBuildAppSettings(string, string, string, StaticSitesListStaticSiteBuildAppSettingsOptionalParams)
Description for Gets the application settings of a static site build.
function listStaticSiteBuildAppSettings(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesListStaticSiteBuildAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
Promise<StringDictionary>
listStaticSiteBuildFunctionAppSettings(string, string, string, StaticSitesListStaticSiteBuildFunctionAppSettingsOptionalParams)
Description for Gets the application settings of a static site build.
function listStaticSiteBuildFunctionAppSettings(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesListStaticSiteBuildFunctionAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
Promise<StringDictionary>
listStaticSiteBuildFunctions(string, string, string, StaticSitesListStaticSiteBuildFunctionsOptionalParams)
Description for Gets the functions of a particular static site build.
function listStaticSiteBuildFunctions(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesListStaticSiteBuildFunctionsOptionalParams): PagedAsyncIterableIterator<StaticSiteFunctionOverviewARMResource, StaticSiteFunctionOverviewARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
listStaticSiteBuilds(string, string, StaticSitesGetStaticSiteBuildsOptionalParams)
Description for Gets all static site builds for a particular static site.
function listStaticSiteBuilds(resourceGroupName: string, name: string, options?: StaticSitesGetStaticSiteBuildsOptionalParams): PagedAsyncIterableIterator<StaticSiteBuildARMResource, StaticSiteBuildARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
listStaticSiteConfiguredRoles(string, string, StaticSitesListStaticSiteConfiguredRolesOptionalParams)
Description for Lists the roles configured for the static site.
function listStaticSiteConfiguredRoles(resourceGroupName: string, name: string, options?: StaticSitesListStaticSiteConfiguredRolesOptionalParams): Promise<StringList>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
Promise<StringList>
listStaticSiteCustomDomains(string, string, StaticSitesListStaticSiteCustomDomainsOptionalParams)
Description for Gets all static site custom domains for a particular static site.
function listStaticSiteCustomDomains(resourceGroupName: string, name: string, options?: StaticSitesListStaticSiteCustomDomainsOptionalParams): PagedAsyncIterableIterator<StaticSiteCustomDomainOverviewARMResource, StaticSiteCustomDomainOverviewARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site resource to search in.
The options parameters.
Returns
listStaticSiteFunctionAppSettings(string, string, StaticSitesListStaticSiteFunctionAppSettingsOptionalParams)
Description for Gets the application settings of a static site.
function listStaticSiteFunctionAppSettings(resourceGroupName: string, name: string, options?: StaticSitesListStaticSiteFunctionAppSettingsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
Promise<StringDictionary>
listStaticSiteFunctions(string, string, StaticSitesListStaticSiteFunctionsOptionalParams)
Description for Gets the functions of a static site.
function listStaticSiteFunctions(resourceGroupName: string, name: string, options?: StaticSitesListStaticSiteFunctionsOptionalParams): PagedAsyncIterableIterator<StaticSiteFunctionOverviewARMResource, StaticSiteFunctionOverviewARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
listStaticSitesByResourceGroup(string, StaticSitesGetStaticSitesByResourceGroupOptionalParams)
Description for Gets all static sites in the specified resource group.
function listStaticSitesByResourceGroup(resourceGroupName: string, options?: StaticSitesGetStaticSitesByResourceGroupOptionalParams): PagedAsyncIterableIterator<StaticSiteARMResource, StaticSiteARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
The options parameters.
Returns
listStaticSiteSecrets(string, string, StaticSitesListStaticSiteSecretsOptionalParams)
Description for Lists the secrets for an existing static site.
function listStaticSiteSecrets(resourceGroupName: string, name: string, options?: StaticSitesListStaticSiteSecretsOptionalParams): Promise<StringDictionary>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
Promise<StringDictionary>
listStaticSiteUsers(string, string, string, StaticSitesListStaticSiteUsersOptionalParams)
Description for Gets the list of users of a static site.
function listStaticSiteUsers(resourceGroupName: string, name: string, authprovider: string, options?: StaticSitesListStaticSiteUsersOptionalParams): PagedAsyncIterableIterator<StaticSiteUserARMResource, StaticSiteUserARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- authprovider
-
string
The auth provider for the users.
The options parameters.
Returns
listUserProvidedFunctionAppsForStaticSite(string, string, StaticSitesGetUserProvidedFunctionAppsForStaticSiteOptionalParams)
Description for Gets the details of the user provided function apps registered with a static site
function listUserProvidedFunctionAppsForStaticSite(resourceGroupName: string, name: string, options?: StaticSitesGetUserProvidedFunctionAppsForStaticSiteOptionalParams): PagedAsyncIterableIterator<StaticSiteUserProvidedFunctionAppARMResource, StaticSiteUserProvidedFunctionAppARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
The options parameters.
Returns
listUserProvidedFunctionAppsForStaticSiteBuild(string, string, string, StaticSitesGetUserProvidedFunctionAppsForStaticSiteBuildOptionalParams)
Description for Gets the details of the user provided function apps registered with a static site build
function listUserProvidedFunctionAppsForStaticSiteBuild(resourceGroupName: string, name: string, environmentName: string, options?: StaticSitesGetUserProvidedFunctionAppsForStaticSiteBuildOptionalParams): PagedAsyncIterableIterator<StaticSiteUserProvidedFunctionAppARMResource, StaticSiteUserProvidedFunctionAppARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- environmentName
-
string
The stage site identifier.
The options parameters.
Returns
previewWorkflow(string, StaticSitesWorkflowPreviewRequest, StaticSitesPreviewWorkflowOptionalParams)
Description for Generates a preview workflow file for the static site
function previewWorkflow(location: string, staticSitesWorkflowPreviewRequest: StaticSitesWorkflowPreviewRequest, options?: StaticSitesPreviewWorkflowOptionalParams): Promise<StaticSitesWorkflowPreview>Parameters
- location
-
string
Location where you plan to create the static site.
- staticSitesWorkflowPreviewRequest
- StaticSitesWorkflowPreviewRequest
A JSON representation of the StaticSitesWorkflowPreviewRequest properties. See example.
The options parameters.
Returns
Promise<StaticSitesWorkflowPreview>
resetStaticSiteApiKey(string, string, StaticSiteResetPropertiesARMResource, StaticSitesResetStaticSiteApiKeyOptionalParams)
Description for Resets the api key for an existing static site.
function resetStaticSiteApiKey(resourceGroupName: string, name: string, resetPropertiesEnvelope: StaticSiteResetPropertiesARMResource, options?: StaticSitesResetStaticSiteApiKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- resetPropertiesEnvelope
- StaticSiteResetPropertiesARMResource
Static Site Reset Properties ARM resource.
The options parameters.
Returns
Promise<void>
unlinkBackend(string, string, string, StaticSitesUnlinkBackendOptionalParams)
Unlink a backend from a static site
function unlinkBackend(resourceGroupName: string, name: string, linkedBackendName: string, options?: StaticSitesUnlinkBackendOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- linkedBackendName
-
string
Name of the backend linked to the static site
The options parameters.
Returns
Promise<void>
unlinkBackendFromBuild(string, string, string, string, StaticSitesUnlinkBackendFromBuildOptionalParams)
Unlink a backend from a static site build
function unlinkBackendFromBuild(resourceGroupName: string, name: string, environmentName: string, linkedBackendName: string, options?: StaticSitesUnlinkBackendFromBuildOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier
- linkedBackendName
-
string
Name of the backend linked to the static site
The options parameters.
Returns
Promise<void>
updateBuildDatabaseConnection(string, string, string, string, DatabaseConnectionPatchRequest, StaticSitesUpdateBuildDatabaseConnectionOptionalParams)
Description for Create or update a database connection for a static site build
function updateBuildDatabaseConnection(resourceGroupName: string, name: string, environmentName: string, databaseConnectionName: string, databaseConnectionRequestEnvelope: DatabaseConnectionPatchRequest, options?: StaticSitesUpdateBuildDatabaseConnectionOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- environmentName
-
string
The stage site identifier.
- databaseConnectionName
-
string
Name of the database connection.
- databaseConnectionRequestEnvelope
- DatabaseConnectionPatchRequest
A JSON representation of the database connection request properties
The options parameters.
Returns
Promise<DatabaseConnection>
updateDatabaseConnection(string, string, string, DatabaseConnectionPatchRequest, StaticSitesUpdateDatabaseConnectionOptionalParams)
Description for Create or update a database connection for a static site
function updateDatabaseConnection(resourceGroupName: string, name: string, databaseConnectionName: string, databaseConnectionRequestEnvelope: DatabaseConnectionPatchRequest, options?: StaticSitesUpdateDatabaseConnectionOptionalParams): Promise<DatabaseConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site
- databaseConnectionName
-
string
Name of the database connection.
- databaseConnectionRequestEnvelope
- DatabaseConnectionPatchRequest
A JSON representation of the database connection request properties
The options parameters.
Returns
Promise<DatabaseConnection>
updateStaticSite(string, string, StaticSitePatchResource, StaticSitesUpdateStaticSiteOptionalParams)
Description for Creates a new static site in an existing resource group, or updates an existing static site.
function updateStaticSite(resourceGroupName: string, name: string, staticSiteEnvelope: StaticSitePatchResource, options?: StaticSitesUpdateStaticSiteOptionalParams): Promise<StaticSiteARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site to create or update.
- staticSiteEnvelope
- StaticSitePatchResource
A JSON representation of the staticsite properties. See example.
The options parameters.
Returns
Promise<StaticSiteARMResource>
updateStaticSiteUser(string, string, string, string, StaticSiteUserARMResource, StaticSitesUpdateStaticSiteUserOptionalParams)
Description for Updates a user entry with the listed roles
function updateStaticSiteUser(resourceGroupName: string, name: string, authprovider: string, userid: string, staticSiteUserEnvelope: StaticSiteUserARMResource, options?: StaticSitesUpdateStaticSiteUserOptionalParams): Promise<StaticSiteUserARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the static site.
- authprovider
-
string
The auth provider for this user.
- userid
-
string
The user id of the user.
- staticSiteUserEnvelope
- StaticSiteUserARMResource
A JSON representation of the StaticSiteUser properties. See example.
The options parameters.
Returns
Promise<StaticSiteUserARMResource>