WebApps API Client — StaticSites. 75 operations. Lead operation: Generates a preview workflow file for the static site. Self-contained Naftiko capability covering one Microsoft Azure Functions business surface.
naftiko: 1.0.0-alpha2
info:
label: WebApps API Client — StaticSites
description: 'WebApps API Client — StaticSites. 75 operations. Lead operation: Generates a preview workflow file for the
static site. Self-contained Naftiko capability covering one Microsoft Azure Functions business surface.'
tags:
- Microsoft Azure Functions
- StaticSites
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
MICROSOFT_AZURE_FUNCTIONS_API_KEY: MICROSOFT_AZURE_FUNCTIONS_API_KEY
capability:
consumes:
- type: http
namespace: azure-functions-management-staticsites
baseUri: https://management.azure.com
description: WebApps API Client — StaticSites business capability. Self-contained, no shared references.
resources:
- name: subscriptions-subscriptionId-providers-Microsoft.Web-locations-location-previewS
path: /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile
operations:
- name: staticsitespreviewworkflow
method: POST
description: Generates a preview workflow file for the static site
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: staticSitesWorkflowPreviewRequest
in: body
type: string
description: The request body
required: true
- name: subscriptions-subscriptionId-providers-Microsoft.Web-staticSites
path: /subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites
operations:
- name: staticsiteslist
method: GET
description: Get all Static Sites for a subscription.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites
operations:
- name: staticsitesgetstaticsitesbyresourcegroup
method: GET
description: Gets all static sites in the specified resource group.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}
operations:
- name: staticsitesgetstaticsite
method: GET
description: Gets the details of a static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: staticsitescreateorupdatestaticsite
method: PUT
description: Creates a new static site in an existing resource group, or updates an existing static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: staticSiteEnvelope
in: body
type: string
description: A JSON representation of the staticsite properties. See example.
required: true
- name: staticsitesupdatestaticsite
method: PATCH
description: Creates a new static site in an existing resource group, or updates an existing static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: staticSiteEnvelope
in: body
type: string
description: A JSON representation of the staticsite properties. See example.
required: true
- name: staticsitesdeletestaticsite
method: DELETE
description: Deletes a static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth
operations:
- name: staticsiteslistbasicauth
method: GET
description: Gets the basic auth properties for a static site as a collection.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}
operations:
- name: staticsitesgetbasicauth
method: GET
description: Gets the basic auth properties for a static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: basicAuthName
in: path
type: string
description: name of the basic auth entry.
required: true
- name: staticsitescreateorupdatebasicauth
method: PUT
description: Adds or updates basic auth for a static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: basicAuthName
in: path
type: string
description: name of the basic auth entry.
required: true
- name: basicAuthEnvelope
in: body
type: string
description: A JSON representation of the basic auth properties.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds
operations:
- name: staticsitesgetstaticsitebuilds
method: GET
description: Gets all static site builds for a particular static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}
operations:
- name: staticsitesgetstaticsitebuild
method: GET
description: Gets the details of a static site build.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: staticsitesdeletestaticsitebuild
method: DELETE
description: Deletes a static site build.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/appsettings
operations:
- name: staticsitescreateorupdatestaticsitebuildappsettings
method: PUT
description: Creates or updates the app settings of a static site build.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: appSettings
in: body
type: string
description: The dictionary containing the static site app settings to update.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/functionappsettings
operations:
- name: staticsitescreateorupdatestaticsitebuildfunctionappsettings
method: PUT
description: Creates or updates the function app settings of a static site build.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: appSettings
in: body
type: string
description: The dictionary containing the static site function app settings to update.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections
operations:
- name: staticsitesgetbuilddatabaseconnections
method: GET
description: Returns overviews of database connections for a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}
operations:
- name: staticsitesgetbuilddatabaseconnection
method: GET
description: Returns overview of a database connection for a static site build by name
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: databaseConnectionName
in: path
type: string
description: Name of the database connection.
required: true
- name: staticsitescreateorupdatebuilddatabaseconnection
method: PUT
description: Create or update a database connection for a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: databaseConnectionName
in: path
type: string
description: Name of the database connection.
required: true
- name: databaseConnectionRequestEnvelope
in: body
type: string
description: A JSON representation of the database connection request properties
required: true
- name: staticsitesupdatebuilddatabaseconnection
method: PATCH
description: Create or update a database connection for a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: databaseConnectionName
in: path
type: string
description: Name of the database connection.
required: true
- name: databaseConnectionRequestEnvelope
in: body
type: string
description: A JSON representation of the database connection request properties
required: true
- name: staticsitesdeletebuilddatabaseconnection
method: DELETE
description: Delete a database connection for a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: databaseConnectionName
in: path
type: string
description: Name of the database connection.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}/show
operations:
- name: staticsitesgetbuilddatabaseconnectionwithdetails
method: POST
description: Returns details of a database connection for a static site build by name
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: databaseConnectionName
in: path
type: string
description: Name of the database connection.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions
operations:
- name: staticsitesliststaticsitebuildfunctions
method: GET
description: Gets the functions of a particular static site build.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends
operations:
- name: staticsitesgetlinkedbackendsforbuild
method: GET
description: Returns details of all backends linked to a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}
operations:
- name: staticsitesgetlinkedbackendforbuild
method: GET
description: Returns the details of a linked backend linked to a static site build by name
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier
required: true
- name: linkedBackendName
in: path
type: string
description: Name of the linked backend that should be retrieved
required: true
- name: staticsiteslinkbackendtobuild
method: PUT
description: Link backend to a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier
required: true
- name: linkedBackendName
in: path
type: string
description: Name of the linked backend that should be retrieved
required: true
- name: staticSiteLinkedBackendEnvelope
in: body
type: string
description: A JSON representation of the linked backend request properties
required: true
- name: staticsitesunlinkbackendfrombuild
method: DELETE
description: Unlink a backend from a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier
required: true
- name: linkedBackendName
in: path
type: string
description: Name of the linked backend that should be retrieved
required: true
- name: isCleaningAuthConfig
in: query
type: boolean
description: Decides if auth will be removed from backend configuration
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}/validate
operations:
- name: staticsitesvalidatebackendforbuild
method: POST
description: Validates that a backend can be linked to a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier
required: true
- name: linkedBackendName
in: path
type: string
description: Name of the linked backend that should be retrieved
required: true
- name: staticSiteLinkedBackendEnvelope
in: body
type: string
description: A JSON representation of the linked backend request properties
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listAppSettings
operations:
- name: staticsitesliststaticsitebuildappsettings
method: POST
description: Gets the application settings of a static site build.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listFunctionAppSettings
operations:
- name: staticsitesliststaticsitebuildfunctionappsettings
method: POST
description: Gets the application settings of a static site build.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/showDatabaseConnections
operations:
- name: staticsitesgetbuilddatabaseconnectionswithdetails
method: POST
description: Returns details of database connections for a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps
operations:
- name: staticsitesgetuserprovidedfunctionappsforstaticsitebuild
method: GET
description: Gets the details of the user provided function apps registered with a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}
operations:
- name: staticsitesgetuserprovidedfunctionappforstaticsitebuild
method: GET
description: Gets the details of the user provided function app registered with a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: functionAppName
in: path
type: string
description: Name of the function app registered with the static site build.
required: true
- name: staticsitesregisteruserprovidedfunctionappwithstaticsitebuild
method: PUT
description: Register a user provided function app with a static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: functionAppName
in: path
type: string
description: Name of the function app registered with the static site build.
required: true
- name: isForced
in: query
type: boolean
description: '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 '
- name: staticSiteUserProvidedFunctionEnvelope
in: body
type: string
description: A JSON representation of the user provided function app properties. See example.
required: true
- name: staticsitesdetachuserprovidedfunctionappfromstaticsitebuild
method: DELETE
description: Detach the user provided function app from the static site build
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: functionAppName
in: path
type: string
description: Name of the function app registered with the static site build.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/zipdeploy
operations:
- name: staticsitescreatezipdeploymentforstaticsitebuild
method: POST
description: Deploys zipped content to a specific environment of a static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: environmentName
in: path
type: string
description: The stage site identifier.
required: true
- name: staticSiteZipDeploymentEnvelope
in: body
type: string
description: A JSON representation of the StaticSiteZipDeployment properties. See example.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings
operations:
- name: staticsitescreateorupdatestaticsiteappsettings
method: PUT
description: Creates or updates the app settings of a static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: appSettings
in: body
type: string
description: The dictionary containing the static site app settings to update.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings
operations:
- name: staticsitescreateorupdatestaticsitefunctionappsettings
method: PUT
description: Creates or updates the function app settings of a static site.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the static site.
required: true
- name: appSettings
in: body
type: string
description: The dictionary containing the static site function app settings to update.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation
operations:
- name: staticsitescreateuserrolesinvitationlink
method: POST
description: Creates an invitation link for a user with the role
outputRawFormat: json
outputParameters:
- name: result
# --- truncated at 32 KB (145 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure-functions/refs/heads/main/capabilities/azure-functions-management-staticsites.yaml