PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}/?api-version=2023-08-01-preview

Create a BuildResource

Servers

Path parameters

Name Type Required Description
buildName String Yes

The name of a build.

subscriptionId String Yes

The ID of the target subscription. The value must be an UUID.

builderName String Yes

The name of the builder.

resourceGroupName String Yes

The name of the resource group. The name is case insensitive.

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
properties Object No

The build properties.

properties.destinationContainerRegistry Object No

Container registry that the final image will be uploaded to.

properties.destinationContainerRegistry.server String Yes

Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it.

properties.destinationContainerRegistry.image String No

Full name that the final image should be uploaded as, including both image name and tag.

properties.provisioningState String No

Resource instance provisioning state.

Possible values:

  • "Succeeded"
  • "Creating"
  • "Deleting"
  • "Canceled"
  • "Updating"
  • "Failed"
properties.uploadEndpoint String No

Endpoint to which the source code should be uploaded.

properties.configuration Object No

Configuration of the build.

properties.configuration.platform String No

Platform to be used to build and run the app.

properties.configuration.preBuildSteps[] Array No

List of steps to perform before the build.

properties.configuration.preBuildSteps[].httpGet Object No

Model representing a http get request.

properties.configuration.preBuildSteps[].httpGet.url String Yes

URL to make HTTP GET request against.

properties.configuration.preBuildSteps[].httpGet.fileName String No

Name of the file that the request should be saved to.

properties.configuration.preBuildSteps[].httpGet.headers[] Array No

List of headers to send with the request.

properties.configuration.preBuildSteps[].description String No

Description of the pre-build step.

properties.configuration.preBuildSteps[].scripts[] Array No

List of custom commands to run.

properties.configuration.platformVersion String No

Platform version to be used to build and run the app.

properties.configuration.environmentVariables[] Array No

List of environment variables to be passed to the build.

properties.configuration.environmentVariables[].name String Yes

Environment variable name.

properties.configuration.environmentVariables[].value String Yes

Environment variable value.

properties.configuration.baseOs String No

Base OS used to build and run the app.

properties.logStreamEndpoint String No

Endpoint from which the build logs can be streamed.

properties.buildStatus String No

Status of the build once it has been provisioned.

Possible values:

  • "NotStarted"
  • "Succeeded"
  • "Canceled"
  • "InProgress"
  • "Failed"
properties.tokenEndpoint String No

Endpoint to use to retrieve an authentication token for log streaming and uploading source code.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.