POST /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile/?api-version=2023-01-01
Description for Generates a preview workflow file for the static site
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
location |
String | Yes |
Location where you plan to create the static site. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id. |
name |
String | No |
Resource Name. |
properties |
Object | No |
StaticSitesWorkflowPreviewRequest resource specific properties |
properties.repositoryUrl |
String | No |
URL for the repository of the static site. |
properties.buildProperties |
Object | No |
Build properties for the static site. |
properties.buildProperties.apiLocation |
String | No |
The path to the api code within the repository. |
properties.buildProperties.appBuildCommand |
String | No |
A custom command to run during deployment of the static content application. |
properties.buildProperties.apiBuildCommand |
String | No |
A custom command to run during deployment of the Azure Functions API application. |
properties.buildProperties.skipGithubActionWorkflowGeneration |
Boolean | No |
Skip Github Action workflow generation. |
properties.buildProperties.appLocation |
String | No |
The path to the app code within the repository. |
properties.buildProperties.githubActionSecretNameOverride |
String | No |
Github Action secret name override. |
properties.buildProperties.appArtifactLocation |
String | No |
Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) |
properties.buildProperties.outputLocation |
String | No |
The output path of the app after building. |
properties.branch |
String | No |
The target branch in the repository. |
type |
String | No |
Resource type. |
kind |
String | No |
Kind of resource. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.