Builds - Create Or Update

Layanan:: Azure Container Apps

Versi API:: 2023-11-02-preview

Membuat BuildResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}?api-version=2023-11-02-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
builderName	path	True	string minLength: 2 maxLength: 32 pattern: ^[-\w\._]+$	Nama penyusun.
buildName	path	True	string minLength: 2 maxLength: 64 pattern: ^[-\w\._]+$	Nama build.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.configuration	BuildConfiguration	Konfigurasi build.
properties.destinationContainerRegistry	ContainerRegistryWithCustomImage	Registri kontainer tempat gambar akhir akan diunggah.

Respons

Nama	Jenis	Deskripsi
200 OK	BuildResource	Operasi pembuatan atau pembaruan ARM berhasil diselesaikan.
201 Created	BuildResource	Operasi pembuatan atau pembaruan ARM telah dimulai. Header Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Respons kesalahan umum.

Nama

Jenis

Deskripsi

200 OK

BuildResource

Operasi pembuatan atau pembaruan ARM berhasil diselesaikan.

201 Created

BuildResource

Operasi pembuatan atau pembaruan ARM telah dimulai.

Header

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Respons kesalahan umum.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Builds_CreateOrUpdate_NoConfig

Builds_CreateOrUpdate_WithConfig

Builds_CreateOrUpdate_NoConfig

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild?api-version=2023-11-02-preview

{}

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild",
  "name": "testBuild",
  "type": "Microsoft.App/builders/builds",
  "properties": {
    "provisioningState": "Succeeded",
    "buildStatus": "InProgress",
    "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
    "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
    "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
  },
  "systemData": {
    "createdBy": "sample@microsoft.com",
    "createdByType": "User",
    "createdAt": "2022-10-11T11:05:51.4940669Z",
    "lastModifiedBy": "sample@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-10-11T11:05:51.4940669Z"
  }
}

Kode status:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild",
  "name": "testBuild",
  "type": "Microsoft.App/build",
  "properties": {
    "provisioningState": "Creating",
    "buildStatus": "InProgress",
    "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
    "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
    "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
  },
  "systemData": {
    "createdBy": "sample@microsoft.com",
    "createdByType": "User",
    "createdAt": "2022-10-11T11:05:51.4940669Z",
    "lastModifiedBy": "sample@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-10-11T11:05:51.4940669Z"
  }
}

Builds_CreateOrUpdate_WithConfig

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild-123456789az?api-version=2023-11-02-preview

{
  "properties": {
    "destinationContainerRegistry": {
      "server": "test.azurecr.io",
      "image": "test.azurecr.io/repo:tag"
    },
    "configuration": {
      "baseOs": "DebianBullseye",
      "platform": "dotnetcore",
      "platformVersion": "7.0",
      "environmentVariables": [
        {
          "name": "foo1",
          "value": "bar1"
        },
        {
          "name": "foo2",
          "value": "bar2"
        }
      ],
      "preBuildSteps": [
        {
          "description": "First pre build step.",
          "scripts": [
            "echo 'hello'",
            "echo 'world'"
          ],
          "httpGet": {
            "url": "https://microsoft.com",
            "fileName": "output.txt",
            "headers": [
              "foo",
              "bar"
            ]
          }
        },
        {
          "description": "Second pre build step.",
          "scripts": [
            "echo 'hello'",
            "echo 'again'"
          ],
          "httpGet": {
            "url": "https://microsoft.com",
            "fileName": "output.txt",
            "headers": [
              "foo"
            ]
          }
        }
      ]
    }
  }
}

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild-123456789az",
  "name": "testBuild-123456789az",
  "type": "Microsoft.App/builders/builds",
  "properties": {
    "provisioningState": "Succeeded",
    "buildStatus": "InProgress",
    "destinationContainerRegistry": {
      "server": "test.azurecr.io",
      "image": "test.azurecr.io/repo:tag"
    },
    "configuration": {
      "baseOs": "DebianBullseye",
      "platform": "dotnetcore",
      "platformVersion": "7.0",
      "environmentVariables": [
        {
          "name": "foo1",
          "value": "bar1"
        },
        {
          "name": "foo2",
          "value": "bar2"
        }
      ],
      "preBuildSteps": [
        {
          "description": "First pre build step.",
          "scripts": [
            "echo 'hello'",
            "echo 'world'"
          ],
          "httpGet": {
            "url": "https://microsoft.com",
            "fileName": "output.txt",
            "headers": [
              "foo",
              "bar"
            ]
          }
        },
        {
          "description": "Second pre build step.",
          "scripts": [
            "echo 'hello'",
            "echo 'again'"
          ],
          "httpGet": {
            "url": "https://microsoft.com",
            "fileName": "output.txt",
            "headers": [
              "foo"
            ]
          }
        }
      ]
    },
    "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
    "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
    "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
  },
  "systemData": {
    "createdBy": "sample@microsoft.com",
    "createdByType": "User",
    "createdAt": "2022-10-11T11:05:51.4940669Z",
    "lastModifiedBy": "sample@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-10-11T11:05:51.4940669Z"
  }
}

Kode status:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild",
  "name": "testBuild",
  "type": "Microsoft.App/build",
  "properties": {
    "provisioningState": "Creating",
    "buildStatus": "NotStarted",
    "destinationContainerRegistry": {
      "server": "test.azurecr.io",
      "image": "test.azurecr.io/repo:tag"
    },
    "configuration": {
      "baseOs": "DebianBullseye",
      "platform": "dotnetcore",
      "platformVersion": "7.0",
      "environmentVariables": [
        {
          "name": "foo1",
          "value": "bar1"
        },
        {
          "name": "foo2",
          "value": "bar2"
        }
      ],
      "preBuildSteps": [
        {
          "description": "First pre build step.",
          "scripts": [
            "echo 'hello'",
            "echo 'world'"
          ],
          "httpGet": {
            "url": "https://microsoft.com",
            "fileName": "output.txt",
            "headers": [
              "foo",
              "bar"
            ]
          }
        },
        {
          "description": "Second pre build step.",
          "scripts": [
            "echo 'hello'",
            "echo 'again'"
          ],
          "httpGet": {
            "url": "https://microsoft.com",
            "fileName": "output.txt",
            "headers": [
              "foo"
            ]
          }
        }
      ]
    },
    "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
    "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
    "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
  },
  "systemData": {
    "createdBy": "sample@microsoft.com",
    "createdByType": "User",
    "createdAt": "2022-10-11T11:05:51.4940669Z",
    "lastModifiedBy": "sample@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-10-11T11:05:51.4940669Z"
  }
}

Definisi

Nama	Deskripsi
BuildConfiguration	Konfigurasi build.
BuildProvisioningState	Status provisi instans sumber daya.
BuildResource	Informasi yang berkaitan dengan build individu.
BuildStatus	Status build setelah disediakan.
ContainerRegistryWithCustomImage	Registri kontainer tempat gambar akhir akan diunggah.
createdByType	Jenis identitas yang membuat sumber daya.
EnvironmentVariable	Model yang mewakili variabel lingkungan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
HttpGet	Model yang mewakili permintaan http get.
PreBuildStep	Model yang mewakili langkah pra-build.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

BuildConfiguration

Objek

Konfigurasi build.

Nama	Jenis	Deskripsi
baseOs	string	OS dasar yang digunakan untuk membangun dan menjalankan aplikasi.
environmentVariables	EnvironmentVariable[]	Daftar variabel lingkungan yang akan diteruskan ke build, rahasia tidak boleh digunakan dalam variabel lingkungan.
platform	string	Platform yang akan digunakan untuk membangun dan menjalankan aplikasi.
platformVersion	string	Versi platform yang akan digunakan untuk membangun dan menjalankan aplikasi.
preBuildSteps	PreBuildStep[]	Daftar langkah-langkah yang harus dilakukan sebelum build.

BuildProvisioningState

Enumerasi

Status provisi instans sumber daya.

Nilai	Deskripsi
Succeeded
Failed
Canceled
Creating
Updating
Deleting

BuildResource

Objek

Informasi yang berkaitan dengan build individu.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.buildStatus	BuildStatus	Status build setelah disediakan.
properties.configuration	BuildConfiguration	Konfigurasi build.
properties.destinationContainerRegistry	ContainerRegistryWithCustomImage	Registri kontainer tempat gambar akhir akan diunggah.
properties.logStreamEndpoint	string	Titik akhir tempat log build dapat dialirkan.
properties.provisioningState	BuildProvisioningState	Membangun status provisi.
properties.tokenEndpoint	string	Titik akhir yang digunakan untuk mengambil token autentikasi untuk streaming log dan mengunggah kode sumber.
properties.uploadEndpoint	string	Titik akhir tempat kode sumber harus diunggah.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

BuildStatus

Enumerasi

Status build setelah disediakan.

Nilai	Deskripsi
NotStarted
InProgress
Succeeded
Canceled
Failed

ContainerRegistryWithCustomImage

Objek

Registri kontainer tempat gambar akhir akan diunggah.

Nama	Jenis	Deskripsi
image	string	Nama lengkap gambar akhir harus diunggah sebagai, termasuk nama gambar dan tag.
server	string	Server masuk registri kontainer tempat gambar akhir harus diunggah. Sumber daya penyusun harus memiliki registri kontainer ini yang ditentukan bersama dengan identitas yang akan digunakan untuk mengaksesnya.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

EnvironmentVariable

Objek

Model yang mewakili variabel lingkungan.

Nama	Jenis	Deskripsi
name	string	Nama variabel lingkungan.
value	string	Nilai variabel lingkungan.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

HttpGet

Objek

Model yang mewakili permintaan http get.

Nama	Jenis	Deskripsi
fileName	string	Nama file tempat permintaan harus disimpan.
headers	string[]	Daftar header yang akan dikirim dengan permintaan.
url	string	URL untuk membuat permintaan HTTP GET terhadap.

PreBuildStep

Objek

Model yang mewakili langkah pra-build.

Nama	Jenis	Deskripsi
description	string	Deskripsi langkah pra-build.
httpGet	HttpGet	Http mendapatkan permintaan untuk dikirim sebelum build.
scripts	string[]	Daftar perintah kustom yang akan dijalankan.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.