openapi: 3.2.0 info: title: WebApps API Client Static Sites API version: '2025-05-01' x-typespec-generated: - emitter: '@azure-tools/typespec-autorest' servers: - url: https://management.azure.com security: - azure_auth: - user_impersonation tags: - name: Static Sites paths: /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile: post: operationId: StaticSites_PreviewWorkflow tags: - Static Sites summary: Generates a preview workflow file for the static site description: Description for Generates a preview workflow file for the static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StaticSitesWorkflowPreview' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Generates a preview workflow file for the static site: $ref: ./examples/GenerateStaticSiteWorkflowPreview.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSitesWorkflowPreviewRequest' description: The request body required: true /subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites: get: operationId: StaticSites_List tags: - Static Sites summary: Get all Static Sites for a subscription description: Description for Get all Static Sites for a subscription. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get all static sites in a subscription: $ref: ./examples/GetAllStaticSites.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites: get: operationId: StaticSites_GetStaticSitesByResourceGroup tags: - Static Sites summary: Gets all static sites in the specified resource group description: Description for Gets all static sites in the specified resource group. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get static sites for a resource group: $ref: ./examples/GetStaticSites.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}: get: operationId: StaticSites_GetStaticSite tags: - Static Sites summary: Gets the details of a static site description: Description for Gets the details of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details for a static site: $ref: ./examples/GetStaticSite.json put: operationId: StaticSites_CreateOrUpdateStaticSite tags: - Static Sites summary: Creates a new static site in an existing resource group, or updates an existing… description: Description for Creates a new static site in an existing resource group, or updates an existing static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Resource 'StaticSiteARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/StaticSiteARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StaticSiteARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Create or update a static site: $ref: ./examples/CreateOrUpdateStaticSite.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/StaticSiteARMResource' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteARMResource' description: A JSON representation of the staticsite properties. See example. required: true patch: operationId: StaticSites_UpdateStaticSite tags: - Static Sites summary: Creates a new static site in an existing resource group, or updates an existing… description: Description for Creates a new static site in an existing resource group, or updates an existing static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. content: application/json: schema: $ref: '#/components/schemas/StaticSiteARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Patch a static site: $ref: ./examples/PatchStaticSite.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSitePatchResource' description: A JSON representation of the staticsite properties. See example. required: true delete: operationId: StaticSites_DeleteStaticSite tags: - Static Sites summary: Deletes a static site description: Description for Deletes a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Resource deleted successfully. '202': description: Resource deletion accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete a static site: $ref: ./examples/DeleteStaticSite.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth: get: operationId: StaticSites_ListBasicAuth tags: - Static Sites summary: Gets the basic auth properties for a static site as a collection description: Description for Gets the basic auth properties for a static site as a collection. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteBasicAuthPropertiesCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Lists the basic auth properties for a static site.: $ref: ./examples/ListStaticSiteBasicAuth.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName} : get: operationId: StaticSites_GetBasicAuth tags: - Static Sites summary: Gets the basic auth properties for a static site description: Description for Gets the basic auth properties for a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: basicAuthName in: path description: name of the basic auth entry. required: true x-ms-enum: name: BasicAuthName modelAsString: true values: - name: default value: default schema: type: string enum: - default responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteBasicAuthPropertiesARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Gets the basic auth properties for a static site.: $ref: ./examples/GetStaticSiteBasicAuth.json put: operationId: StaticSites_CreateOrUpdateBasicAuth tags: - Static Sites summary: Adds or updates basic auth for a static site description: Description for Adds or updates basic auth for a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: basicAuthName in: path description: name of the basic auth entry. required: true x-ms-enum: name: BasicAuthName modelAsString: true values: - name: default value: default schema: type: string enum: - default responses: '200': description: Resource 'StaticSiteBasicAuthPropertiesARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/StaticSiteBasicAuthPropertiesARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Creates or updates basic auth properties for a static site.: $ref: ./examples/CreateOrUpdateStaticSiteBasicAuth.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteBasicAuthPropertiesARMResource' description: A JSON representation of the basic auth properties. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds: get: operationId: StaticSites_GetStaticSiteBuilds tags: - Static Sites summary: Gets all static site builds for a particular static site description: Description for Gets all static site builds for a particular static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteBuildCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get all builds for a static site: $ref: ./examples/GetStaticSiteBuilds.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName} : get: operationId: StaticSites_GetStaticSiteBuild tags: - Static Sites summary: Gets the details of a static site build description: Description for Gets the details of a static site build. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteBuildARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get a static site build: $ref: ./examples/GetStaticSiteBuild.json delete: operationId: StaticSites_DeleteStaticSiteBuild tags: - Static Sites summary: Deletes a static site build description: Description for Deletes a static site build. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Resource deleted successfully. '202': description: Resource deletion accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete a static site build: $ref: ./examples/DeleteStaticSiteBuild.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/appsettings : put: operationId: StaticSites_CreateOrUpdateStaticSiteBuildAppSettings tags: - Static Sites summary: Creates or updates the app settings of a static site build description: Description for Creates or updates the app settings of a static site build. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Creates or updates the function app settings of a static site build.: $ref: ./examples/CreateOrUpdateStaticSiteBuildAppSettings.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: The dictionary containing the static site app settings to update. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/functionappsettings : put: operationId: StaticSites_CreateOrUpdateStaticSiteBuildFunctionAppSettings tags: - Static Sites summary: Creates or updates the function app settings of a static site build description: Description for Creates or updates the function app settings of a static site build. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Creates or updates the function app settings of a static site build.: $ref: ./examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: The dictionary containing the static site function app settings to update. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections : get: operationId: StaticSites_GetBuildDatabaseConnections tags: - Static Sites summary: Returns overviews of database connections for a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnectionCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List overviews of database connections for the static site build.: $ref: ./examples/GetStaticSiteBuildDatabaseConnections.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName} : get: operationId: StaticSites_GetBuildDatabaseConnection tags: - Static Sites summary: Returns overview of a database connection for a static site build by name parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get overview of database connections for the static site build.: $ref: ./examples/GetStaticSiteBuildDatabaseConnection.json put: operationId: StaticSites_CreateOrUpdateBuildDatabaseConnection tags: - Static Sites summary: Create or update a database connection for a static site build description: Description for Create or update a database connection for a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Resource 'DatabaseConnection' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Create or update a database connection for a static site build: $ref: ./examples/CreateOrUpdateStaticSiteBuildDatabaseConnection.json requestBody: content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' description: A JSON representation of the database connection request properties required: true patch: operationId: StaticSites_UpdateBuildDatabaseConnection tags: - Static Sites summary: Create or update a database connection for a static site build description: Description for Create or update a database connection for a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Patch a database connection for a static site build: $ref: ./examples/PatchStaticSiteBuildDatabaseConnection.json requestBody: content: application/json: schema: $ref: '#/components/schemas/DatabaseConnectionPatchRequest' description: A JSON representation of the database connection request properties required: true delete: operationId: StaticSites_DeleteBuildDatabaseConnection tags: - Static Sites summary: Delete a database connection for a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete a database connection from a static site build.: $ref: ./examples/DeleteStaticSiteBuildDatabaseConnection.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}/show : post: operationId: StaticSites_GetBuildDatabaseConnectionWithDetails tags: - Static Sites summary: Returns details of a database connection for a static site build by name parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of database connections for the static site build.: $ref: ./examples/GetStaticSiteBuildDatabaseConnectionWithDetails.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions : get: operationId: StaticSites_ListStaticSiteBuildFunctions tags: - Static Sites summary: Gets the functions of a particular static site build description: Description for Gets the functions of a particular static site build. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteFunctionOverviewCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Gets the functions of a particular static site build: $ref: ./examples/ListStaticSiteBuildFunctions.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends : get: operationId: StaticSites_GetLinkedBackendsForBuild tags: - Static Sites summary: Returns details of all backends linked to a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendsCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the linked backends registered with a static site build.: $ref: ./examples/GetLinkedBackendsForStaticSiteBuild.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName} : get: operationId: StaticSites_GetLinkedBackendForBuild tags: - Static Sites summary: Returns the details of a linked backend linked to a static site build by name parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the linked backend registered with a static site build by name.: $ref: ./examples/GetLinkedBackendForStaticSiteBuild.json put: operationId: StaticSites_LinkBackendToBuild tags: - Static Sites summary: Link backend to a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string responses: '200': description: The request has succeeded. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Link a backend to a static site build: $ref: ./examples/LinkBackendToStaticSiteBuild.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/StaticSiteLinkedBackendARMResource' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' description: A JSON representation of the linked backend request properties required: true delete: operationId: StaticSites_UnlinkBackendFromBuild tags: - Static Sites summary: Unlink a backend from a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string - name: isCleaningAuthConfig in: query description: Decides if auth will be removed from backend configuration required: false schema: type: boolean responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Unlink a backend from a static site build.: $ref: ./examples/UnlinkBackendFromStaticSiteBuild.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}/validate : post: operationId: StaticSites_ValidateBackendForBuild tags: - Static Sites summary: Validates that a backend can be linked to a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: environmentName in: path description: The stage site identifier required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string responses: '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 '204': description: There is no content to send for this request, but the headers may be useful. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Validate if backend can be linked to static site build.: $ref: ./examples/ValidateLinkedBackendForStaticSiteBuild.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' description: A JSON representation of the linked backend request properties required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listAppSettings : post: operationId: StaticSites_ListStaticSiteBuildAppSettings tags: - Static Sites summary: Gets the application settings of a static site build description: Description for Gets the application settings of a static site build. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get app settings of a static site build: $ref: ./examples/ListStaticSiteBuildAppSettings.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listFunctionAppSettings : post: operationId: StaticSites_ListStaticSiteBuildFunctionAppSettings tags: - Static Sites summary: Gets the application settings of a static site build description: Description for Gets the application settings of a static site build. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get function app settings of a static site build: $ref: ./examples/ListStaticSiteBuildFunctionAppSettings.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/showDatabaseConnections : post: operationId: StaticSites_GetBuildDatabaseConnectionsWithDetails tags: - Static Sites summary: Returns details of database connections for a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnectionCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List full details of database connections for the static site build.: $ref: ./examples/GetStaticSiteBuildDatabaseConnectionsWithDetails.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps : get: operationId: StaticSites_GetUserProvidedFunctionAppsForStaticSiteBuild tags: - Static Sites summary: Gets the details of the user provided function apps registered with a static… description: Description for Gets the details of the user provided function apps registered with a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppsCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the user provided function apps registered with a static site build.: $ref: ./examples/GetUserProvidedFunctionAppsForStaticSiteBuild.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName} : get: operationId: StaticSites_GetUserProvidedFunctionAppForStaticSiteBuild tags: - Static Sites summary: Gets the details of the user provided function app registered with a static… description: Description for Gets the details of the user provided function app registered with a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string - name: functionAppName in: path description: Name of the function app registered with the static site build. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the user provided function app registered with a static site build.: $ref: ./examples/GetUserProvidedFunctionAppForStaticSiteBuild.json put: operationId: StaticSites_RegisterUserProvidedFunctionAppWithStaticSiteBuild tags: - Static Sites summary: Register a user provided function app with a static site build description: Description for Register a user provided function app with a static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string - name: functionAppName in: path description: Name of the function app registered with the static site build. required: true schema: type: string - name: isForced in: query description: Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false. required: false schema: type: boolean responses: '200': description: Resource 'StaticSiteUserProvidedFunctionAppARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Register a user provided function app with a static site build: $ref: ./examples/RegisterUserProvidedFunctionAppWithStaticSiteBuild.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/StaticSiteUserProvidedFunctionAppARMResource' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' description: A JSON representation of the user provided function app properties. See example. required: true delete: operationId: StaticSites_DetachUserProvidedFunctionAppFromStaticSiteBuild tags: - Static Sites summary: Detach the user provided function app from the static site build description: Description for Detach the user provided function app from the static site build parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string - name: functionAppName in: path description: Name of the function app registered with the static site build. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Detach the user provided function app from the static site build.: $ref: ./examples/DetachUserProvidedFunctionAppFromStaticSiteBuild.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/zipdeploy : post: operationId: StaticSites_CreateZipDeploymentForStaticSiteBuild tags: - Static Sites summary: Deploys zipped content to a specific environment of a static site description: Description for Deploys zipped content to a specific environment of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: environmentName in: path description: The stage site identifier. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Deploy a site from a zipped package to a particular static site build: $ref: ./examples/StaticSiteBuildZipDeploy.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteZipDeploymentARMResource' description: A JSON representation of the StaticSiteZipDeployment properties. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings : put: operationId: StaticSites_CreateOrUpdateStaticSiteAppSettings tags: - Static Sites summary: Creates or updates the app settings of a static site description: Description for Creates or updates the app settings of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Creates or updates the app settings of a static site.: $ref: ./examples/CreateOrUpdateStaticSiteAppSettings.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: The dictionary containing the static site app settings to update. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings : put: operationId: StaticSites_CreateOrUpdateStaticSiteFunctionAppSettings tags: - Static Sites summary: Creates or updates the function app settings of a static site description: Description for Creates or updates the function app settings of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Creates or updates the function app settings of a static site.: $ref: ./examples/CreateOrUpdateStaticSiteFunctionAppSettings.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: The dictionary containing the static site function app settings to update. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation : post: operationId: StaticSites_CreateUserRolesInvitationLink tags: - Static Sites summary: Creates an invitation link for a user with the role description: Description for Creates an invitation link for a user with the role parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserInvitationResponseResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Create an invitation link for a user for a static site: $ref: ./examples/CreateUserRolesInvitationLink.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserInvitationRequestResource' required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains : get: operationId: StaticSites_ListStaticSiteCustomDomains tags: - Static Sites summary: Gets all static site custom domains for a particular static site description: Description for Gets all static site custom domains for a particular static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteCustomDomainOverviewCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List custom domains for a static site: $ref: ./examples/GetStaticSiteCustomDomains.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName} : get: operationId: StaticSites_GetStaticSiteCustomDomain tags: - Static Sites summary: Gets an existing custom domain for a particular static site description: Description for Gets an existing custom domain for a particular static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: domainName in: path description: The custom domain name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteCustomDomainOverviewARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get custom domain for a static site: $ref: ./examples/GetStaticSiteCustomDomain.json put: operationId: StaticSites_CreateOrUpdateStaticSiteCustomDomain tags: - Static Sites summary: Creates a new static site custom domain in an existing resource group and… description: Description for Creates a new static site custom domain in an existing resource group and static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: domainName in: path description: The custom domain name. required: true schema: type: string responses: '200': description: Resource 'StaticSiteCustomDomainOverviewARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/StaticSiteCustomDomainOverviewARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StaticSiteCustomDomainOverviewARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Create or update a custom domain for a static site: $ref: ./examples/CreateOrUpdateStaticSiteCustomDomain.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/StaticSiteCustomDomainOverviewARMResource' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteCustomDomainRequestPropertiesARMResource' description: A JSON representation of the static site custom domain request properties. See example. required: true delete: operationId: StaticSites_DeleteStaticSiteCustomDomain tags: - Static Sites summary: Deletes a custom domain description: Description for Deletes a custom domain. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: domainName in: path description: The custom domain name. required: true schema: type: string responses: '200': description: Resource deleted successfully. '202': description: Resource deletion accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete a custom domain for a static site: $ref: ./examples/DeleteStaticSiteCustomDomain.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}/validate : post: operationId: StaticSites_ValidateCustomDomainCanBeAddedToStaticSite tags: - Static Sites summary: Validates a particular custom domain can be added to a static site description: Description for Validates a particular custom domain can be added to a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: domainName in: path description: The custom domain name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Validate a custom domain for a static site: $ref: ./examples/ValidateStaticSiteCustomDomain.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteCustomDomainRequestPropertiesARMResource' description: A JSON representation of the static site custom domain request properties. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections : get: operationId: StaticSites_GetDatabaseConnections tags: - Static Sites summary: Returns overviews of database connections for a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnectionCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List overviews of database connections for the static site.: $ref: ./examples/GetStaticSiteDatabaseConnections.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName} : get: operationId: StaticSites_GetDatabaseConnection tags: - Static Sites summary: Returns overview of a database connection for a static site by name parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get overview of database connections for the static site.: $ref: ./examples/GetStaticSiteDatabaseConnection.json put: operationId: StaticSites_CreateOrUpdateDatabaseConnection tags: - Static Sites summary: Create or update a database connection for a static site description: Description for Create or update a database connection for a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Resource 'DatabaseConnection' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Create or update a database connection for a static site: $ref: ./examples/CreateOrUpdateStaticSiteDatabaseConnection.json requestBody: content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' description: A JSON representation of the database connection request properties required: true patch: operationId: StaticSites_UpdateDatabaseConnection tags: - Static Sites summary: Create or update a database connection for a static site description: Description for Create or update a database connection for a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Patch a database connection for a static site: $ref: ./examples/PatchStaticSiteDatabaseConnection.json requestBody: content: application/json: schema: $ref: '#/components/schemas/DatabaseConnectionPatchRequest' description: A JSON representation of the database connection request properties required: true delete: operationId: StaticSites_DeleteDatabaseConnection tags: - Static Sites summary: Delete a database connection for a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete a database connection from a static site.: $ref: ./examples/DeleteStaticSiteDatabaseConnection.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}/show : post: operationId: StaticSites_GetDatabaseConnectionWithDetails tags: - Static Sites summary: Returns details of a database connection for a static site by name parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: databaseConnectionName in: path description: Name of the database connection. required: true schema: type: string pattern: ^[a-zA-Z0-9]+$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of database connections for the static site.: $ref: ./examples/GetStaticSiteDatabaseConnectionWithDetails.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/detach: post: operationId: StaticSites_DetachStaticSite tags: - Static Sites summary: Detaches a static site description: Description for Detaches a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Detach a static site: $ref: ./examples/DetachStaticSite.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions: get: operationId: StaticSites_ListStaticSiteFunctions tags: - Static Sites summary: Gets the functions of a static site description: Description for Gets the functions of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteFunctionOverviewCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Gets the functions of a static site: $ref: ./examples/ListStaticSiteFunctions.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends : get: operationId: StaticSites_GetLinkedBackends tags: - Static Sites summary: Returns details of all backends linked to a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendsCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the linked backends registered with a static site.: $ref: ./examples/GetLinkedBackendsForStaticSite.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName} : get: operationId: StaticSites_GetLinkedBackend tags: - Static Sites summary: Returns the details of a linked backend linked to a static site by name parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the linked backend registered with a static site by name.: $ref: ./examples/GetLinkedBackendForStaticSite.json put: operationId: StaticSites_LinkBackend tags: - Static Sites summary: Link backend to a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string responses: '200': description: The request has succeeded. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Link a backend to a static site: $ref: ./examples/LinkBackendToStaticSite.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/StaticSiteLinkedBackendARMResource' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' description: A JSON representation of the linked backend request properties required: true delete: operationId: StaticSites_UnlinkBackend tags: - Static Sites summary: Unlink a backend from a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string - name: isCleaningAuthConfig in: query description: Decides if Easy Auth configuration will be removed from backend configuration required: false schema: type: boolean responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Unlink a backend from a static site.: $ref: ./examples/UnlinkBackendFromStaticSite.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}/validate : post: operationId: StaticSites_ValidateBackend tags: - Static Sites summary: Validates that a backend can be linked to a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site required: true schema: type: string - name: linkedBackendName in: path description: Name of the linked backend that should be retrieved required: true schema: type: string responses: '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 '204': description: There is no content to send for this request, but the headers may be useful. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Validate if backend can be linked to static site.: $ref: ./examples/ValidateLinkedBackendForStaticSite.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' description: A JSON representation of the linked backend request properties required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listAppSettings : post: operationId: StaticSites_ListStaticSiteAppSettings tags: - Static Sites summary: Gets the application settings of a static site description: Description for Gets the application settings of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get app settings of a static site: $ref: ./examples/ListStaticSiteAppSettings.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listConfiguredRoles : post: operationId: StaticSites_ListStaticSiteConfiguredRoles tags: - Static Sites summary: Lists the roles configured for the static site description: Description for Lists the roles configured for the static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringList' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Lists the configured roles for a static site: $ref: ./examples/ListStaticSiteConfiguredRoles.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings : post: operationId: StaticSites_ListStaticSiteFunctionAppSettings tags: - Static Sites summary: Gets the application settings of a static site description: Description for Gets the application settings of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get function app settings of a static site: $ref: ./examples/ListStaticSiteFunctionAppSettings.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listSecrets: post: operationId: StaticSites_ListStaticSiteSecrets tags: - Static Sites summary: Lists the secrets for an existing static site description: Description for Lists the secrets for an existing static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List secrets for a static site: $ref: ./examples/ListStaticSiteSecrets.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections : get: operationId: StaticSites_GetPrivateEndpointConnectionList tags: - Static Sites summary: Gets the list of private endpoint connections associated with a static site description: Description for Gets the list of private endpoint connections associated with a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get a list of private endpoint connections associated with a site.: $ref: ./examples/GetSitePrivateEndpointConnectionList.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName} : get: operationId: StaticSites_GetPrivateEndpointConnection tags: - Static Sites summary: Gets a private endpoint connection description: Description for Gets a private endpoint connection parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get a private endpoint connection for a site.: $ref: ./examples/GetSitePrivateEndpointConnection_StaticSites.json put: operationId: StaticSites_ApproveOrRejectPrivateEndpointConnection tags: - Static Sites summary: Approves or rejects a private endpoint connection description: Description for Approves or rejects a private endpoint connection parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Approves or rejects a private endpoint connection for a site.: $ref: ./examples/ApproveRejectSitePrivateEndpointConnection_StaticSites.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/RemotePrivateEndpointConnectionARMResource' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' description: Request body. required: true delete: operationId: StaticSites_DeletePrivateEndpointConnection tags: - Static Sites summary: Deletes a private endpoint connection description: Description for Deletes a private endpoint connection parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: {} '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: {} '204': description: 'There is no content to send for this request, but the headers may be useful. ' content: application/json: schema: {} default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete a private endpoint connection for a site.: $ref: ./examples/DeleteSitePrivateEndpointConnection_StaticSites.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateLinkResources : get: operationId: StaticSites_GetPrivateLinkResources tags: - Static Sites summary: Gets the private link resources description: Description for Gets the private link resources parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateLinkResourcesWrapper' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get private link resources of a site: $ref: ./examples/GetSitePrivateLinkResources.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/resetapikey: post: operationId: StaticSites_ResetStaticSiteApiKey tags: - Static Sites summary: Resets the api key for an existing static site description: Description for Resets the api key for an existing static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Reset the api key for a static site: $ref: ./examples/ResetStaticSiteApiKey.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteResetPropertiesARMResource' required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/showDatabaseConnections : post: operationId: StaticSites_GetDatabaseConnectionsWithDetails tags: - Static Sites summary: Returns details of database connections for a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DatabaseConnectionCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List full details of database connections for the static site.: $ref: ./examples/GetStaticSiteDatabaseConnectionsWithDetails.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps : get: operationId: StaticSites_GetUserProvidedFunctionAppsForStaticSite tags: - Static Sites summary: Gets the details of the user provided function apps registered with a static… description: Description for Gets the details of the user provided function apps registered with a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppsCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the user provided function apps registered with a static site.: $ref: ./examples/GetUserProvidedFunctionAppsForStaticSite.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName} : get: operationId: StaticSites_GetUserProvidedFunctionAppForStaticSite tags: - Static Sites summary: Gets the details of the user provided function app registered with a static site description: Description for Gets the details of the user provided function app registered with a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: functionAppName in: path description: Name of the function app registered with the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get details of the user provided function app registered with a static site.: $ref: ./examples/GetUserProvidedFunctionAppForStaticSite.json put: operationId: StaticSites_RegisterUserProvidedFunctionAppWithStaticSite tags: - Static Sites summary: Register a user provided function app with a static site description: Description for Register a user provided function app with a static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: functionAppName in: path description: Name of the function app registered with the static site. required: true schema: type: string - name: isForced in: query description: Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false. required: false schema: type: boolean responses: '200': description: Resource 'StaticSiteUserProvidedFunctionAppARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Register a user provided function app with a static site: $ref: ./examples/RegisterUserProvidedFunctionAppWithStaticSite.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/StaticSiteUserProvidedFunctionAppARMResource' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' description: A JSON representation of the user provided function app properties. See example. required: true delete: operationId: StaticSites_DetachUserProvidedFunctionAppFromStaticSite tags: - Static Sites summary: Detach the user provided function app from the static site description: Description for Detach the user provided function app from the static site parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string - name: functionAppName in: path description: Name of the function app registered with the static site. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Detach the user provided function app from the static site.: $ref: ./examples/DetachUserProvidedFunctionAppFromStaticSite.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/zipdeploy: post: operationId: StaticSites_CreateZipDeploymentForStaticSite tags: - Static Sites summary: Deploys zipped content to a static site description: Description for Deploys zipped content to a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the static site. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Deploy a site from a zipped package: $ref: ./examples/StaticSiteZipDeploy.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteZipDeploymentARMResource' description: A JSON representation of the StaticSiteZipDeployment properties. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/staticSites/{name}/authproviders/{authprovider}/listUsers : post: operationId: StaticSites_ListStaticSiteUsers tags: - Static Sites summary: Gets the list of users of a static site description: Description for Gets the list of users of a static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path required: true schema: type: string - name: authprovider in: path description: The auth provider for the users. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List users for a static site: $ref: ./examples/ListStaticSiteUsers.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid} : patch: operationId: StaticSites_UpdateStaticSiteUser tags: - Static Sites summary: Updates a user entry with the listed roles description: Description for Updates a user entry with the listed roles parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path required: true schema: type: string - name: authprovider in: path required: true schema: type: string - name: userid in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Create or update a user for a static site: $ref: ./examples/UpdateStaticSiteUser.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticSiteUserARMResource' description: A JSON representation of the StaticSiteUser properties. See example. required: true delete: operationId: StaticSites_DeleteStaticSiteUser tags: - Static Sites summary: Deletes the user entry from the static site description: Description for Deletes the user entry from the static site. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path required: true schema: type: string - name: authprovider in: path required: true schema: type: string - name: userid in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete a user for a static site: $ref: ./examples/DeleteStaticSiteUser.json components: schemas: StaticSiteUserCollection: type: object description: Collection of static site custom users. properties: value: type: array description: The StaticSiteUserARMResource items on this page items: $ref: '#/components/schemas/StaticSiteUserARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value BuildStatus: type: string description: The status of the static site build. enum: - WaitingForDeployment - Uploading - Deploying - Ready - Failed - Deleting - Detached x-ms-enum: name: BuildStatus modelAsString: true values: - name: WaitingForDeployment value: WaitingForDeployment - name: Uploading value: Uploading - name: Deploying value: Deploying - name: Ready value: Ready - name: Failed value: Failed - name: Deleting value: Deleting - name: Detached value: Detached StaticSitesWorkflowPreviewProperties: type: object description: StaticSitesWorkflowPreview resource specific properties properties: path: type: string description: The path for the workflow file to be generated readOnly: true contents: type: string description: The contents for the workflow file to be generated readOnly: true StaticSiteUserARMResource: type: object description: Static Site User ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteUserARMResourceProperties' description: StaticSiteUserARMResource resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StaticSiteCustomDomainOverviewARMResource: type: object description: Static Site Custom Domain Overview ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteCustomDomainOverviewARMResourceProperties' description: StaticSiteCustomDomainOverviewARMResource resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource ErrorEntity: type: object description: Body of the error response returned from the API. properties: extendedCode: type: string description: Type of error. messageTemplate: type: string description: Message template. parameters: type: array description: Parameters for the template. items: type: string innerErrors: type: array description: Inner errors. items: $ref: '#/components/schemas/ErrorEntity' x-ms-identifiers: [] details: type: array description: Error Details. items: $ref: '#/components/schemas/ErrorEntity' x-ms-identifiers: [] target: type: string description: The error target. code: type: string description: Basic error code. message: type: string description: Any details of the error. StaticSiteLinkedBackendARMResource: type: object description: Static Site Linked Backend ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResourceProperties' description: StaticSiteLinkedBackendARMResource resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource StaticSitesWorkflowPreview: type: object description: Preview for the Static Site Workflow to be generated properties: properties: $ref: '#/components/schemas/StaticSitesWorkflowPreviewProperties' description: StaticSitesWorkflowPreview resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' Capability: type: object description: Describes the capabilities/features allowed for a specific SKU. properties: name: type: string description: Name of the SKU capability. value: type: string description: Value of the SKU capability. reason: type: string description: Reason of the SKU capability. StaticSiteLinkedBackend: type: object description: Static Site Linked Backend ARM resource. properties: backendResourceId: type: string description: The resource id of the backend linked to the static site region: type: string description: The region of the backend linked to the static site createdOn: type: string format: date-time description: The date and time on which the backend was linked to the static site. readOnly: true provisioningState: type: string description: The provisioning state of the linking process. readOnly: true DatabaseConnectionPatchRequest: type: object description: Static Site Database Connection Request Properties resource when patching properties: properties: $ref: '#/components/schemas/DatabaseConnectionPatchRequestProperties' description: DatabaseConnectionPatchRequest resource specific properties x-ms-client-flatten: true StaticSitesWorkflowPreviewRequest: type: object description: Request entity for previewing the Static Site workflow properties: properties: $ref: '#/components/schemas/StaticSitesWorkflowPreviewRequestProperties' description: StaticSitesWorkflowPreviewRequest resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StaticSiteResetPropertiesARMResource: type: object description: Static Site Reset Properties ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteResetPropertiesARMResourceProperties' description: StaticSiteResetPropertiesARMResource resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' DatabaseConnection: type: object description: Static Site Database Connection resource. properties: properties: $ref: '#/components/schemas/DatabaseConnectionProperties' description: DatabaseConnection resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource StaticSiteUserProvidedFunctionAppARMResource: type: object description: Static Site User Provided Function App ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResourceProperties' description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource StaticSiteFunctionOverviewARMResourceProperties: type: object description: StaticSiteFunctionOverviewARMResource resource specific properties properties: functionName: type: string description: The name for the function readOnly: true triggerType: $ref: '#/components/schemas/TriggerTypes' description: The trigger type of the function readOnly: true StaticSiteUserInvitationRequestResourceProperties: type: object description: StaticSiteUserInvitationRequestResource resource specific properties properties: domain: type: string description: The domain name for the static site custom domain. provider: type: string description: The identity provider for the static site user. userDetails: type: string description: The user id for the static site user. roles: type: string description: The roles for the static site user, in free-form string format numHoursToExpiration: type: integer format: int32 description: The number of hours the sas token stays valid StaticSiteBuildCollection: type: object description: Collection of static site builds. properties: value: type: array description: The StaticSiteBuildARMResource items on this page items: $ref: '#/components/schemas/StaticSiteBuildARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value StaticSiteUserProvidedFunctionAppARMResourceProperties: type: object description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties properties: functionAppResourceId: type: string description: The resource id of the function app registered with the static site functionAppRegion: type: string description: The region of the function app registered with the static site createdOn: type: string format: date-time description: The date and time on which the function app was registered with the static site. readOnly: true StaticSitesWorkflowPreviewRequestProperties: type: object description: StaticSitesWorkflowPreviewRequest resource specific properties properties: repositoryUrl: type: string description: URL for the repository of the static site. branch: type: string description: The target branch in the repository. buildProperties: $ref: '#/components/schemas/StaticSiteBuildProperties' description: Build properties to configure on the repository. ProxyOnlyResource: type: object description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: type: string description: Resource Id. readOnly: true name: type: string description: Resource Name. readOnly: true kind: type: string description: Kind of resource. type: type: string description: Resource type. readOnly: true DefaultErrorResponse: type: object description: App Service error response. properties: error: $ref: '#/components/schemas/DefaultErrorResponseError' description: Error model. readOnly: true RemotePrivateEndpointConnectionProperties: type: object description: RemotePrivateEndpointConnection resource specific properties properties: provisioningState: type: string readOnly: true privateEndpoint: $ref: '#/components/schemas/ArmIdWrapper' description: PrivateEndpoint of a remote private endpoint connection privateLinkServiceConnectionState: $ref: '#/components/schemas/PrivateLinkConnectionState' description: The state of a private link connection ipAddresses: type: array description: Private IPAddresses mapped to the remote private endpoint items: type: string StagingEnvironmentPolicy: type: string description: State indicating whether staging environments are allowed or not allowed for a static web app. enum: - Enabled - Disabled x-ms-enum: name: StagingEnvironmentPolicy modelAsString: false ArmPlan: type: object description: The plan object in Azure Resource Manager, represents a marketplace plan. properties: name: type: string description: The name. publisher: type: string description: The publisher. product: type: string description: The product. promotionCode: type: string description: The promotion code. version: type: string description: Version of product. RemotePrivateEndpointConnection: type: object description: A remote private endpoint connection properties: properties: $ref: '#/components/schemas/RemotePrivateEndpointConnectionProperties' description: RemotePrivateEndpointConnection resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' ArmIdWrapper: type: object description: A wrapper for an ARM resource id properties: id: type: string readOnly: true StaticSiteUserInvitationResponseResource: type: object description: Static sites user roles invitation link resource. properties: properties: $ref: '#/components/schemas/StaticSiteUserInvitationResponseResourceProperties' description: StaticSiteUserInvitationResponseResource resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StringDictionary: type: object description: String dictionary resource. properties: properties: type: object description: Settings. additionalProperties: type: string x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' PrivateEndpointConnectionCollection: type: object description: Paged collection of RemotePrivateEndpointConnectionARMResource items properties: value: type: array description: The RemotePrivateEndpointConnectionARMResource items on this page items: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value PrivateLinkResourceProperties: type: object description: Properties of a private link resource properties: groupId: type: string description: GroupId of a private link resource readOnly: true requiredMembers: type: array description: RequiredMembers of a private link resource items: type: string readOnly: true requiredZoneNames: type: array description: RequiredZoneNames of a private link resource items: type: string readOnly: true DatabaseConnectionOverview: type: object description: Static Site Database Connection overview. properties: resourceId: type: string description: The resource id of the database. readOnly: true connectionIdentity: type: string description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. readOnly: true region: type: string description: The region of the database resource. readOnly: true configurationFiles: type: array description: A list of configuration files associated with this database connection. items: $ref: '#/components/schemas/StaticSiteDatabaseConnectionConfigurationFileOverview' readOnly: true x-ms-identifiers: - fileName name: type: string description: If present, the name of this database connection resource. readOnly: true ManagedServiceIdentity: type: object description: Managed service identity. properties: type: $ref: '#/components/schemas/ManagedServiceIdentityType' description: Type of managed service identity. tenantId: type: string description: Tenant of managed service identity. readOnly: true principalId: type: string description: Principal Id of managed service identity. readOnly: true userAssignedIdentities: type: object description: 'The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' additionalProperties: $ref: '#/components/schemas/UserAssignedIdentity' PrivateLinkConnectionState: type: object description: The state of a private link connection properties: status: type: string description: Status of a private link connection description: type: string description: Description of a private link connection actionsRequired: type: string description: ActionsRequired for a private link connection RemotePrivateEndpointConnectionARMResourceProperties: type: object description: RemotePrivateEndpointConnectionARMResource resource specific properties properties: provisioningState: type: string readOnly: true privateEndpoint: $ref: '#/components/schemas/ArmIdWrapper' description: PrivateEndpoint of a remote private endpoint connection privateLinkServiceConnectionState: $ref: '#/components/schemas/PrivateLinkConnectionState' description: The state of a private link connection ipAddresses: type: array description: Private IPAddresses mapped to the remote private endpoint items: type: string StaticSiteBasicAuthPropertiesARMResource: type: object description: Static site basic auth properties ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteBasicAuthPropertiesARMResourceProperties' description: StaticSiteBasicAuthPropertiesARMResource resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource StaticSiteCollection: type: object description: Collection of static sites. properties: value: type: array description: The StaticSiteARMResource items on this page items: $ref: '#/components/schemas/StaticSiteARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value CustomDomainStatus: type: string description: The status of the custom domain enum: - RetrievingValidationToken - Validating - Adding - Ready - Failed - Deleting - Unhealthy x-ms-enum: name: CustomDomainStatus modelAsString: true values: - name: RetrievingValidationToken value: RetrievingValidationToken - name: Validating value: Validating - name: Adding value: Adding - name: Ready value: Ready - name: Failed value: Failed - name: Deleting value: Deleting - name: Unhealthy value: Unhealthy StaticSiteLinkedBackendARMResourceProperties: type: object description: StaticSiteLinkedBackendARMResource resource specific properties properties: backendResourceId: type: string description: The resource id of the backend linked to the static site region: type: string description: The region of the backend linked to the static site createdOn: type: string format: date-time description: The date and time on which the backend was linked to the static site. readOnly: true provisioningState: type: string description: The provisioning state of the linking process. readOnly: true StaticSiteBuildARMResource: type: object description: Static Site Build ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteBuildARMResourceProperties' description: StaticSiteBuildARMResource resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource StaticSiteResetPropertiesARMResourceProperties: type: object description: StaticSiteResetPropertiesARMResource resource specific properties properties: repositoryToken: type: string description: The token which proves admin privileges to the repository. shouldUpdateRepository: type: boolean description: Determines whether the repository should be updated with the new properties. StaticSiteUserProvidedFunctionApp: type: object description: A static site user provided function. properties: properties: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppProperties' description: StaticSiteUserProvidedFunctionApp resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' DatabaseConnectionProperties: type: object description: DatabaseConnection resource specific properties properties: resourceId: type: string description: The resource id of the database. connectionIdentity: type: string description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. connectionString: type: string description: The connection string to use to connect to the database. region: type: string description: The region of the database resource. configurationFiles: type: array description: A list of configuration files associated with this database connection. items: $ref: '#/components/schemas/StaticSiteDatabaseConnectionConfigurationFileOverview' readOnly: true x-ms-identifiers: - fileName required: - resourceId - region StaticSiteUserProvidedFunctionAppProperties: type: object description: StaticSiteUserProvidedFunctionApp resource specific properties properties: functionAppResourceId: type: string description: The resource id of the function app registered with the static site functionAppRegion: type: string description: The region of the function app registered with the static site createdOn: type: string format: date-time description: The date and time on which the function app was registered with the static site. readOnly: true StaticSiteBasicAuthPropertiesARMResourceProperties: type: object description: StaticSiteBasicAuthPropertiesARMResource resource specific properties properties: password: type: string description: The password for basic auth. secretUrl: type: string description: Url to the secret in Key Vault. applicableEnvironmentsMode: type: string description: State indicating if basic auth is enabled and for what environments it is active. environments: type: array description: The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. items: type: string secretState: type: string description: State indicating if basic auth has a secret and what type it is. readOnly: true required: - applicableEnvironmentsMode StaticSitePatchResource: type: object description: ARM resource for a static site when patching properties: properties: $ref: '#/components/schemas/StaticSite' description: Core resource properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StaticSiteFunctionOverviewCollection: type: object description: Collection of static site functions. properties: value: type: array description: The StaticSiteFunctionOverviewARMResource items on this page items: $ref: '#/components/schemas/StaticSiteFunctionOverviewARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value SkuCapacity: type: object description: Description of the App Service plan scale options. properties: minimum: type: integer format: int32 description: Minimum number of workers for this App Service plan SKU. maximum: type: integer format: int32 description: Maximum number of workers for this App Service plan SKU. elasticMaximum: type: integer format: int32 description: Maximum number of Elastic workers for this App Service plan SKU. default: type: integer format: int32 description: Default number of workers for this App Service plan SKU. scaleType: type: string description: Available scale configurations for an App Service plan. StaticSiteCustomDomainOverviewARMResourceProperties: type: object description: StaticSiteCustomDomainOverviewARMResource resource specific properties properties: domainName: type: string description: The domain name for the static site custom domain. readOnly: true createdOn: type: string format: date-time description: The date and time on which the custom domain was created for the static site. readOnly: true status: $ref: '#/components/schemas/CustomDomainStatus' description: The status of the custom domain readOnly: true validationToken: type: string description: The TXT record validation token readOnly: true errorMessage: type: string readOnly: true DefaultErrorResponseError: type: object description: Error model. properties: code: type: string description: Standardized string to programmatically identify the error. readOnly: true message: type: string description: Detailed error description and debugging information. readOnly: true target: type: string description: Detailed error description and debugging information. readOnly: true details: type: array items: $ref: '#/components/schemas/DefaultErrorResponseErrorDetailsItem' x-ms-identifiers: [] innererror: type: string description: More information to debug error. readOnly: true StaticSiteBuildProperties: type: object description: Build properties for the static site. properties: appLocation: type: string description: The path to the app code within the repository. apiLocation: type: string description: The path to the api code within the repository. appArtifactLocation: type: string description: 'Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)' outputLocation: type: string description: The output path of the app after building. appBuildCommand: type: string description: A custom command to run during deployment of the static content application. apiBuildCommand: type: string description: A custom command to run during deployment of the Azure Functions API application. skipGithubActionWorkflowGeneration: type: boolean description: Skip Github Action workflow generation. githubActionSecretNameOverride: type: string description: Github Action secret name override. StaticSiteZipDeploymentARMResource: type: object description: Static site zip deployment ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteZipDeployment' description: Core resource properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StaticSiteUserARMResourceProperties: type: object description: StaticSiteUserARMResource resource specific properties properties: provider: type: string description: The identity provider for the static site user. readOnly: true userId: type: string description: The user id for the static site user. readOnly: true displayName: type: string description: The display name for the static site user. readOnly: true roles: type: string description: The roles for the static site user, in free-form string format StaticSiteCustomDomainRequestPropertiesARMResource: type: object description: Static Site Custom Domain Request Properties ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteCustomDomainRequestPropertiesARMResourceProperties' description: StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StaticSite: type: object description: A static site. properties: defaultHostname: type: string description: The default autogenerated hostname for the static site. readOnly: true repositoryUrl: type: string description: URL for the repository of the static site. branch: type: string description: The target branch in the repository. customDomains: type: array description: The custom domains associated with this static site. items: type: string readOnly: true repositoryToken: type: string description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. buildProperties: $ref: '#/components/schemas/StaticSiteBuildProperties' description: Build properties to configure on the repository. privateEndpointConnections: type: array description: Private endpoint connections items: $ref: '#/components/schemas/ResponseMessageEnvelopeRemotePrivateEndpointConnection' readOnly: true stagingEnvironmentPolicy: $ref: '#/components/schemas/StagingEnvironmentPolicy' description: State indicating whether staging environments are allowed or not allowed for a static web app. allowConfigFileUpdates: type: boolean description: false if config file is locked for this static web app; otherwise, true. templateProperties: $ref: '#/components/schemas/StaticSiteTemplateOptions' description: Template options for generating a new repository. contentDistributionEndpoint: type: string description: The content distribution endpoint for the static site. readOnly: true keyVaultReferenceIdentity: type: string description: Identity to use for Key Vault Reference authentication. readOnly: true userProvidedFunctionApps: type: array description: User provided function apps registered with the static site items: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionApp' readOnly: true linkedBackends: type: array description: Backends linked to the static side items: $ref: '#/components/schemas/StaticSiteLinkedBackend' readOnly: true x-ms-identifiers: [] provider: type: string description: The provider that submitted the last deployment to the primary environment of the static site. enterpriseGradeCdnStatus: $ref: '#/components/schemas/EnterpriseGradeCdnStatus' description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. publicNetworkAccess: type: string description: 'State indicating whether public traffic are allowed or not for a static web app. Allowed Values: ''Enabled'', ''Disabled'' or an empty string.' databaseConnections: type: array description: Database connections for the static site items: $ref: '#/components/schemas/DatabaseConnectionOverview' readOnly: true x-ms-identifiers: - name StaticSiteARMResource: type: object description: Concrete tracked resource types can be created by aliasing this type using a specific property type. properties: properties: $ref: '#/components/schemas/StaticSite' description: Core resource properties x-ms-client-flatten: true kind: type: string description: Kind of resource. sku: $ref: '#/components/schemas/SkuDescription' description: Description of a SKU for a scalable resource. identity: $ref: '#/components/schemas/ManagedServiceIdentity' description: Managed service identity. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource ResponseMessageEnvelopeRemotePrivateEndpointConnection: type: object description: Message envelope that contains the common Azure resource manager properties and the resource provider specific content. properties: id: type: string description: 'Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}' name: type: string description: Name of resource. type: type: string description: Type of resource e.g "Microsoft.Web/sites". location: type: string description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. tags: type: object description: Tags associated with resource. additionalProperties: type: string plan: $ref: '#/components/schemas/ArmPlan' description: Azure resource manager plan. properties: $ref: '#/components/schemas/RemotePrivateEndpointConnection' description: Resource specific properties. sku: $ref: '#/components/schemas/SkuDescription' description: SKU description of the resource. status: type: string description: Azure-AsyncOperation Status info. error: $ref: '#/components/schemas/ErrorEntity' description: Azure-AsyncOperation Error info. identity: $ref: '#/components/schemas/ManagedServiceIdentity' description: MSI resource zones: type: array description: Logical Availability Zones the service is hosted in items: type: string StaticSiteBasicAuthPropertiesCollection: type: object description: Collection of static site basic auth. properties: value: type: array description: The StaticSiteBasicAuthPropertiesARMResource items on this page items: $ref: '#/components/schemas/StaticSiteBasicAuthPropertiesARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value StaticSiteLinkedBackendsCollection: type: object description: Collection of static site linked backends. properties: value: type: array description: The StaticSiteLinkedBackendARMResource items on this page items: $ref: '#/components/schemas/StaticSiteLinkedBackendARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value RemotePrivateEndpointConnectionARMResource: type: object description: Remote Private Endpoint Connection ARM resource. properties: properties: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResourceProperties' description: RemotePrivateEndpointConnectionARMResource resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource StaticSiteUserInvitationResponseResourceProperties: type: object description: StaticSiteUserInvitationResponseResource resource specific properties properties: expiresOn: type: string format: date-time description: The expiration time of the invitation readOnly: true invitationUrl: type: string description: The url for the invitation link readOnly: true DatabaseConnectionCollection: type: object description: Collection of static site database connections. properties: value: type: array description: The DatabaseConnection items on this page items: $ref: '#/components/schemas/DatabaseConnection' nextLink: type: string format: uri description: The link to the next page of items required: - value ManagedServiceIdentityType: type: string description: Type of managed service identity. enum: - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned - None x-ms-enum: name: ManagedServiceIdentityType modelAsString: false SkuDescription: type: object description: Description of a SKU for a scalable resource. properties: name: type: string description: Name of the resource SKU. tier: type: string description: Service tier of the resource SKU. size: type: string description: Size specifier of the resource SKU. family: type: string description: Family code of the resource SKU. capacity: type: integer format: int32 description: Current number of instances assigned to the resource. skuCapacity: $ref: '#/components/schemas/SkuCapacity' description: Min, max, and default scale values of the SKU. locations: type: array description: Locations of the SKU. items: type: string capabilities: type: array description: Capabilities of the SKU, e.g., is traffic manager enabled? items: $ref: '#/components/schemas/Capability' x-ms-identifiers: - name EnterpriseGradeCdnStatus: type: string description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. enum: - Enabled - Enabling - Disabled - Disabling x-ms-enum: name: EnterpriseGradeCdnStatus modelAsString: true values: - name: Enabled value: Enabled - name: Enabling value: Enabling - name: Disabled value: Disabled - name: Disabling value: Disabling StaticSiteZipDeployment: type: object description: A static site zip deployment. properties: appZipUrl: type: string description: URL for the zipped app content apiZipUrl: type: string description: URL for the zipped api content deploymentTitle: type: string description: A title to label the deployment provider: type: string description: The provider submitting this deployment functionLanguage: type: string description: The language of the api content, if it exists StaticSiteFunctionOverviewARMResource: type: object description: Static Site Function Overview ARM resource. properties: properties: $ref: '#/components/schemas/StaticSiteFunctionOverviewARMResourceProperties' description: StaticSiteFunctionOverviewARMResource resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StaticSiteUserInvitationRequestResource: type: object description: Static sites user roles invitation resource. properties: properties: $ref: '#/components/schemas/StaticSiteUserInvitationRequestResourceProperties' description: StaticSiteUserInvitationRequestResource resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' DatabaseConnectionPatchRequestProperties: type: object description: DatabaseConnectionPatchRequest resource specific properties properties: resourceId: type: string description: The resource id of the database. connectionIdentity: type: string description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. connectionString: type: string description: The connection string to use to connect to the database. region: type: string description: The region of the database resource. StaticSiteBuildARMResourceProperties: type: object description: StaticSiteBuildARMResource resource specific properties properties: buildId: type: string description: An identifier for the static site build. readOnly: true sourceBranch: type: string description: The source branch. readOnly: true pullRequestTitle: type: string description: The title of a pull request that a static site build is related to. readOnly: true hostname: type: string description: The hostname for a static site build. readOnly: true createdTimeUtc: type: string format: date-time description: When this build was created. readOnly: true lastUpdatedOn: type: string format: date-time description: When this build was updated. readOnly: true status: $ref: '#/components/schemas/BuildStatus' description: The status of the static site build. readOnly: true userProvidedFunctionApps: type: array description: User provided function apps registered with the static site build items: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionApp' readOnly: true linkedBackends: type: array description: Backends linked to the static side build items: $ref: '#/components/schemas/StaticSiteLinkedBackend' readOnly: true x-ms-identifiers: [] databaseConnections: type: array description: Database connections for the static site build items: $ref: '#/components/schemas/DatabaseConnectionOverview' readOnly: true x-ms-identifiers: - name StringList: type: object description: String list resource. properties: properties: type: array description: List of string resources. items: type: string allOf: - $ref: '#/components/schemas/ProxyOnlyResource' StaticSiteTemplateOptions: type: object description: Template Options for the static site. properties: templateRepositoryUrl: type: string description: URL of the template repository. The newly generated repository will be based on this one. owner: type: string description: Owner of the newly generated repository. repositoryName: type: string description: Name of the newly generated repository. description: type: string description: Description of the newly generated repository. isPrivate: type: boolean description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). StaticSiteDatabaseConnectionConfigurationFileOverview: type: object description: A database connection configuration file properties: fileName: type: string description: The name of the configuration file. readOnly: true contents: type: string description: The Base64 encoding of the file contents. readOnly: true type: type: string description: The type of configuration file. readOnly: true PrivateLinkResource: type: object description: A private link resource properties: id: type: string name: type: string description: Name of a private link resource type: type: string properties: $ref: '#/components/schemas/PrivateLinkResourceProperties' description: Properties of a private link resource required: - id - name - type - properties PrivateLinkResourcesWrapper: type: object description: Wrapper for a collection of private link resources properties: value: type: array items: $ref: '#/components/schemas/PrivateLinkResource' required: - value StaticSiteUserProvidedFunctionAppsCollection: type: object description: Collection of static site user provided function apps. properties: value: type: array description: The StaticSiteUserProvidedFunctionAppARMResource items on this page items: $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value DefaultErrorResponseErrorDetailsItem: type: object description: Detailed errors. properties: code: type: string description: Standardized string to programmatically identify the error. readOnly: true message: type: string description: Detailed error description and debugging information. readOnly: true target: type: string description: Detailed error description and debugging information. readOnly: true StaticSiteCustomDomainRequestPropertiesARMResourceProperties: type: object description: StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties properties: validationMethod: type: string description: Validation method for adding a custom domain default: cname-delegation UserAssignedIdentity: type: object description: User Assigned identity. properties: principalId: type: string description: Principal Id of user assigned identity readOnly: true clientId: type: string description: Client Id of user assigned identity readOnly: true StaticSiteCustomDomainOverviewCollection: type: object description: Collection of static site custom domains. properties: value: type: array description: The StaticSiteCustomDomainOverviewARMResource items on this page items: $ref: '#/components/schemas/StaticSiteCustomDomainOverviewARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value TriggerTypes: type: string description: The trigger type of the function enum: - HttpTrigger - Unknown x-ms-enum: name: TriggerTypes modelAsString: true values: - name: HttpTrigger value: HttpTrigger - name: Unknown value: Unknown securitySchemes: azure_auth: type: oauth2 flows: implicit: scopes: user_impersonation: impersonate your user account authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize description: Azure Active Directory OAuth2 Flow.