Statiska webbapparAnvändareMaskinöversatt

API-referens

Alla HTTP-slutpunkter i modulen staticwebapps: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.

Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.

Docs

`GET /docs/staticwebapps/manifest.json`

Autentisering: krävs
Operationsnamn: DocsManifest_staticwebapps

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token

`GET /docs/staticwebapps/{path}`

Autentisering: krävs
Operationsnamn: DocsFile_staticwebapps

Parametrar

Namn	Plats	Typ	Obligatorisk
`path`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token

Static Web Apps

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deploy`

Rebuild the site from the current branch head

Autentisering: krävs
IAM-åtgärd: staticwebapp/deploy — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/deploy på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments`

Deployment history for a static web app

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments`

Autentisering: krävs

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja

Begärans innehåll: DeploymentLogEntryDto

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/config`

Filter and sort options for the deployment history list

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`string`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

`PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/{deploymentId}`

Autentisering: krävs

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja
`deploymentId`	sökväg	`uuid`	Ja

Begärans innehåll: DeploymentLogEntryDto

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/{deploymentId}/build-logs`

Packaging output for one deployment — persisted if it finished, live if it has not

Autentisering: krävs
IAM-åtgärd: staticwebapp/readLogs — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja
`deploymentId`	sökväg	`uuid`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/readLogs på det utvärderade omfånget

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/{deploymentId}/logs`

Autentisering: krävs

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja
`deploymentId`	sökväg	`uuid`	Ja

Begärans innehåll: UploadBuildLogsRequest

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/logs`

Stream the site's nginx logs

Autentisering: krävs
IAM-åtgärd: staticwebapp/readLogs — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/readLogs på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/pods`

List the site's serving pods, for the log tab's pod picker

Autentisering: krävs
IAM-åtgärd: staticwebapp/readLogs — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/readLogs på det utvärderade omfånget

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/rollback`

Serve a previously-built image without rebuilding

Autentisering: krävs
IAM-åtgärd: staticwebapp/deploy — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroup`	sökväg	`string`	Ja
`name`	sökväg	`string`	Ja

Begärans innehåll: StaticWebAppRollbackRequest

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/deploy på det utvärderade omfånget

`POST /boundaries/{boundaryId}/resources/staticwebapps/url`

Preview the default public URL for a static web app

Autentisering: krävs
IAM-åtgärd: staticwebapp/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja

Begärans innehåll: StaticWebAppUrlRequest

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/write på det utvärderade omfånget

StaticWebApp

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps`

List all staticwebapps in a resource group

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen
Operationsnamn: ListStaticWebApps

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/config`

Get list configuration for staticwebapps

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen
Operationsnamn: GetStaticWebAppsConfig

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`string`	Ja
`resourceGroupName`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

`DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}`

Delete a staticwebapp

Autentisering: krävs
IAM-åtgärd: staticwebapp/delete — utvärderas på resursen i sökvägen
Operationsnamn: DeleteStaticWebApp

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/delete på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}`

Get a specific staticwebapp

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen
Operationsnamn: GetStaticWebApp

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

`PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}`

Partially update an existing staticwebapp using JSON Merge Patch

Autentisering: krävs
IAM-åtgärd: staticwebapp/write — utvärderas på resursen i sökvägen
Operationsnamn: PatchStaticWebApp

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja

Begärans innehåll: any

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/write på det utvärderade omfånget

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}`

Create a new staticwebapp

Autentisering: krävs
IAM-åtgärd: staticwebapp/write — utvärderas på resursen i sökvägen
Operationsnamn: CreateStaticWebApp

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja

Begärans innehåll: StaticWebAppDto

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/write på det utvärderade omfånget

`PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}`

Update an existing staticwebapp

Autentisering: krävs
IAM-åtgärd: staticwebapp/write — utvärderas på resursen i sökvägen
Operationsnamn: UpdateStaticWebApp

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja

Begärans innehåll: StaticWebAppDto

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/write på det utvärderade omfånget

`PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}/actions/{action}`

Execute a lifecycle action (start, stop, restart) on a staticwebapp

Autentisering: krävs
IAM-åtgärd: staticwebapp/write — utvärderas på resursen i sökvägen
Operationsnamn: ExecuteStaticWebAppAction

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja
`action`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/write på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}/scale`

Get current scale of a staticwebapp

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen
Operationsnamn: GetStaticWebAppScale

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}/scale`

Scale a staticwebapp

Autentisering: krävs
IAM-åtgärd: staticwebapp/scale — utvärderas på resursen i sökvägen
Operationsnamn: ScaleStaticWebApp

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`resourceName`	sökväg	`string`	Ja

Begärans innehåll: ScaleRequest

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/scale på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resources/staticwebapps`

List all staticwebapps across all resource groups

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen
Operationsnamn: ListAllStaticWebApps

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resources/staticwebapps/config`

Get list configuration for all staticwebapps

Autentisering: krävs
IAM-åtgärd: staticwebapp/read — utvärderas på resursen i sökvägen
Operationsnamn: GetAllStaticWebAppsConfig

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`string`	Ja

Svar

Status	Betydelse	Innehåll
`200`	OK
`401`	Inte inloggad, eller ogiltig token
`403`	Anroparen har inte staticwebapp/read på det utvärderade omfånget

Scheman

`DeploymentLogEntryDto`

Egenskap	Typ	Kan vara null
`boundaryId`	`uuid`	Nej
`branch`	`string`	Ja
`canServe`	`boolean`	Nej
`commitSha`	`string`	Ja
`containerImage`	`string`	Ja
`deploymentId`	`uuid`	Nej
`id`	`uuid`	Nej
`isServing`	`boolean`	Nej
`lastMessage`	`string`	Nej
`phase`	`string`	Nej
`provider`	`string`	Ja
`repositoryName`	`string`	Ja
`resourceGroupName`	`string`	Nej
`siteName`	`string`	Nej
`source`	`string`	Ja
`timestamp`	`date-time`	Nej

`ScaleRequest`

Egenskap	Typ	Kan vara null
`targetScale`	`integer`	Nej

`StaticWebAppDeploymentDto`

Egenskap	Typ	Kan vara null
`finishedAt`	`date-time`	Ja
`image`	`string`	Ja
`message`	`string`	Ja
`number`	`integer`	Nej
`result`	`string`	Ja
`revision`	`string`	Ja
`startedAt`	`date-time`	Ja

`StaticWebAppDto`

Egenskap	Typ	Kan vara null
`boundary`	`string`	Nej
`boundaryId`	`uuid`	Nej
`branch`	`string`	Nej
`cacheControl`	`string`	Nej
`certificateStatus`	`string`	Ja
`clusterId`	`uuid`	Nej
`clusterName`	`string`	Nej
`collection`	`string`	Nej
`commit`	`string`	Ja
`createdAt`	`date-time`	Nej
`currentDeployment`	`StaticWebAppDeploymentDto`	Ja
`headers`	`StaticWebAppHeaderDto` `[]`	Ja
`hostname`	`string`	Ja
`httpOnly`	`boolean`	Nej
`id`	`uuid`	Nej
`lastDeployment`	`StaticWebAppDeploymentDto`	Ja
`name`	`string`	Nej
`navigationFallback`	`string`	Ja
`navigationFallbackExclude`	`string` `[]`	Ja
`notFoundPage`	`string`	Ja
`phase`	`string`	Ja
`pinnedImage`	`string`	Ja
`redirects`	`StaticWebAppRedirectDto` `[]`	Ja
`region`	`string`	Nej
`replicas`	`integer`	Nej
`repositoryId`	`string`	Nej
`repositoryUrl`	`string`	Nej
`resourceGroup`	`string`	Nej
`rolloutError`	`string`	Ja
`serveDirectory`	`string`	Nej
`sourceId`	`string`	Nej
`sourceProvider`	`string`	Nej
`specObserved`	`boolean`	Nej
`status`	`string`	Nej
`tags`	`map` (`string`)	Nej
`url`	`string`	Ja

`StaticWebAppHeaderDto`

Egenskap	Typ	Kan vara null
`name`	`string`	Nej
`path`	`string`	Nej
`value`	`string`	Nej

`StaticWebAppRedirectDto`

Egenskap	Typ	Kan vara null
`from`	`string`	Nej
`statusCode`	`integer`	Nej
`to`	`string`	Nej

`UploadBuildLogsRequest`

Egenskap	Typ	Kan vara null
`logs`	`string`	Nej
`timestamp`	`date-time`	Nej