Bagikan melalui

Jobs - Get

  • Referensi
Service:
Azure Container Apps
API Version:
2024-03-01

Mendapatkan properti Pekerjaan Aplikasi Kontainer.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}?api-version=2024-03-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
jobName
 path True

string

Nama pekerjaan

Regex pattern: ^[-\w\._\(\)]+$
resourceGroupName
 path True

string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId
 path True

string

ID langganan target.
api-version
 query True

string

Versi API yang digunakan untuk operasi ini.

Respons

Nama Jenis Deskripsi
200 OK

Job

OK.
Other Status Codes

DefaultErrorResponse

Respons kesalahan umum.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

Get Container Apps Job

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0?api-version=2024-03-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0",
  "name": "testcontainerappsjob0",
  "type": "Microsoft.App/jobs",
  "location": "East US",
  "properties": {
    "provisioningState": "Succeeded",
    "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
    "configuration": {
      "replicaTimeout": 10,
      "replicaRetryLimit": 10,
      "manualTriggerConfig": {
        "replicaCompletionCount": 1,
        "parallelism": 4
      },
      "triggerType": "Manual"
    },
    "template": {
      "containers": [
        {
          "image": "repo/testcontainerappsjob0:v4",
          "name": "testcontainerappsjob0",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          }
        }
      ],
      "initContainers": [
        {
          "image": "repo/testcontainerappsjob0:v4",
          "name": "testinitcontainerAppsJob0",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          }
        }
      ]
    }
  }
}

Definisi

Nama Deskripsi
Container

Definisi kontainer Aplikasi Kontainer
ContainerAppProbe

Pemeriksaan menjelaskan pemeriksaan kesehatan yang akan dilakukan terhadap kontainer untuk menentukan apakah itu hidup atau siap menerima lalu lintas.
ContainerResources

Persyaratan sumber daya kontainer Aplikasi Kontainer.
createdByType

Jenis identitas yang membuat sumber daya.
DefaultErrorResponse

App Service respons kesalahan.
Details

Detail atau kesalahan
EnvironmentVar

Variabel lingkungan kontainer Aplikasi Kontainer.
Error

Model kesalahan.
EventTriggerConfig

Memicu konfigurasi pekerjaan berbasis peristiwa.
HttpGet

HTTPGet menentukan permintaan http yang akan dilakukan.
HttpHeaders

Header kustom untuk diatur dalam permintaan. HTTP memungkinkan header berulang.
InitContainer

Definisi kontainer init Aplikasi Kontainer
Job

Pekerjaan Aplikasi Kontainer
JobConfiguration

Properti konfigurasi Pekerjaan Aplikasi Kontainer non-versi
JobProvisioningState

Status provisi Pekerjaan Aplikasi Kontainer.
JobScale

Konfigurasi penskalaan untuk pekerjaan berbasis peristiwa.
JobScaleRule

Aturan penskalakan.
JobTemplate

Definisi aplikasi versi Container Apps Job. Menentukan status revisi yang diinginkan dari revisi yang tidak dapat diubah. Setiap perubahan pada bagian ini Akan mengakibatkan revisi baru dibuat
ManagedServiceIdentity

Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
ManagedServiceIdentityType

Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
ManualTriggerConfig

Konfigurasi pemicu manual untuk satu pekerjaan eksekusi. Properti replicaCompletionCount dan paralelisme akan diatur ke 1 secara default
RegistryCredentials

Registri Privat Aplikasi Kontainer
ScaleRuleAuth

Rahasia Autentikasi untuk Aturan Skala
ScheduleTriggerConfig

Cron memformat jadwal pemicu berulang ("* * * * *") untuk cronjobs. Penyelesaian properti dan paralelisme akan diatur ke 1 secara default
Scheme

Skema yang digunakan untuk menyambungkan ke host. Default ke HTTP.
Secret

Definisi rahasia.
SecretVolumeItem

Rahasia untuk ditambahkan ke volume.
StorageType

Jenis penyimpanan untuk volume. Jika tidak disediakan, gunakan EmptyDir.
systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TcpSocket

TCPSocket menentukan tindakan yang melibatkan port TCP. Kait TCP belum didukung.
TriggerType

Jenis pemicu pekerjaan
Type

Jenis pemeriksaan.
UserAssignedIdentity

Properti identitas yang ditetapkan pengguna
Volume

Definisi volume untuk Aplikasi Kontainer.
VolumeMount

Pemasangan volume untuk Aplikasi Kontainer.

Container

Definisi kontainer Aplikasi Kontainer

Nama Jenis Deskripsi
args

string[]

Argumen perintah mulai kontainer.
command

string[]

Perintah mulai kontainer.
env

EnvironmentVar[]

Variabel lingkungan kontainer.
image

string

Tag gambar kontainer.
name

string

Nama kontainer kustom.
probes

ContainerAppProbe[]

Daftar probe untuk kontainer.
resources

ContainerResources

Persyaratan sumber daya kontainer.
volumeMounts

VolumeMount[]

Pemasangan volume kontainer.

ContainerAppProbe

Pemeriksaan menjelaskan pemeriksaan kesehatan yang akan dilakukan terhadap kontainer untuk menentukan apakah itu hidup atau siap menerima lalu lintas.

Nama Jenis Deskripsi
failureThreshold

integer

Kegagalan minimum berturut-turut agar pemeriksaan dianggap gagal setelah berhasil. Default ke 3. Nilai minimalnya adalah 1. Nilai maksimum adalah 10.
httpGet

HttpGet

HTTPGet menentukan permintaan http yang akan dilakukan.
initialDelaySeconds

integer

Jumlah detik setelah kontainer dimulai sebelum probe keaktifan dimulai. Nilai minimalnya adalah 1. Nilai maksimum adalah 60.
periodSeconds

integer

Seberapa sering (dalam hitungan detik) untuk melakukan probe. Default ke 10 detik. Nilai minimalnya adalah 1. Nilai maksimum adalah 240.
successThreshold

integer

Keberhasilan minimum berturut-turut untuk pemeriksaan dianggap berhasil setelah gagal. Default ke 1. Harus 1 untuk keaktifan dan startup. Nilai minimalnya adalah 1. Nilai maksimum adalah 10.
tcpSocket

TcpSocket

TCPSocket menentukan tindakan yang melibatkan port TCP. Kait TCP belum didukung.
terminationGracePeriodSeconds

integer

Durasi opsional dalam detik pod perlu dihentikan dengan baik setelah kegagalan pemeriksaan. Masa tenggang adalah durasi dalam hitungan detik setelah proses yang berjalan di pod dikirim sinyal penghentian dan waktu ketika proses dihentikan secara paksa dengan sinyal kill. Atur nilai ini lebih lama dari waktu pembersihan yang diharapkan untuk proses Anda. Jika nilai ini nihil, terminationGracePeriodSeconds pod akan digunakan. Jika tidak, nilai ini akan menggantikan nilai yang disediakan oleh spesifikasi pod. Nilai harus bilangan bulat non-negatif. Nilai nol menunjukkan berhenti segera melalui sinyal matikan (tidak ada kesempatan untuk mematikan). Ini adalah bidang alfa dan memerlukan pengaktifan gerbang fitur ProbeTerminationGracePeriod. Nilai maksimum adalah 3600 detik (1 jam)
timeoutSeconds

integer

Jumlah detik setelah waktu pemeriksaan habis. Default ke 1 detik. Nilai minimalnya adalah 1. Nilai maksimum adalah 240.
type

Type

Jenis probe.

ContainerResources

Persyaratan sumber daya kontainer Aplikasi Kontainer.

Nama Jenis Deskripsi
cpu

number

CPU yang diperlukan dalam inti, misalnya 0,5
ephemeralStorage

string

Penyimpanan Ephemeral, misalnya "1Gi"
memory

string

Memori yang diperlukan, misalnya "250Mb"

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultErrorResponse

App Service respons kesalahan.

Nama Jenis Deskripsi
error

Error

Model kesalahan.

Details

Detail atau kesalahan

Nama Jenis Deskripsi
code

string

String standar untuk mengidentifikasi kesalahan secara terprogram.
message

string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target

string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

EnvironmentVar

Variabel lingkungan kontainer Aplikasi Kontainer.

Nama Jenis Deskripsi
name

string

Nama variabel lingkungan.
secretRef

string

Nama rahasia Aplikasi Kontainer untuk menarik nilai variabel lingkungan.
value

string

Nilai variabel lingkungan non-rahasia.

Error

Model kesalahan.

Nama Jenis Deskripsi
code

string

String standar untuk mengidentifikasi kesalahan secara terprogram.
details

Details[]

Detail atau kesalahan
innererror

string

Informasi selengkapnya untuk men-debug kesalahan.
message

string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target

string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

EventTriggerConfig

Memicu konfigurasi pekerjaan berbasis peristiwa.

Nama Jenis Deskripsi
parallelism

integer

Jumlah replika paralel pekerjaan yang dapat berjalan pada waktu tertentu.
replicaCompletionCount

integer

Jumlah minimum penyelesaian replika yang berhasil sebelum penyelesaian pekerjaan secara keseluruhan.
scale

JobScale

Konfigurasi penskalaan untuk pekerjaan berbasis peristiwa.

HttpGet

HTTPGet menentukan permintaan http yang akan dilakukan.

Nama Jenis Deskripsi
host

string

Nama host untuk disambungkan, default ke IP pod. Anda mungkin ingin mengatur "Host" di httpHeaders sebagai gantinya.
httpHeaders

HttpHeaders[]

Header kustom untuk diatur dalam permintaan. HTTP memungkinkan header berulang.
path

string

Jalur untuk mengakses di server HTTP.
port

integer

Nama atau nomor port yang akan diakses pada kontainer. Angka harus dalam rentang 1 hingga 65535. Nama harus berupa IANA_SVC_NAME.
scheme

Scheme

Skema yang digunakan untuk menyambungkan ke host. Default ke HTTP.

HttpHeaders

Header kustom untuk diatur dalam permintaan. HTTP memungkinkan header berulang.

Nama Jenis Deskripsi
name

string

Nama bidang header
value

string

Nilai bidang header

InitContainer

Definisi kontainer init Aplikasi Kontainer

Nama Jenis Deskripsi
args

string[]

Argumen perintah mulai kontainer.
command

string[]

Perintah mulai kontainer.
env

EnvironmentVar[]

Variabel lingkungan kontainer.
image

string

Tag gambar kontainer.
name

string

Nama kontainer kustom.
resources

ContainerResources

Persyaratan sumber daya kontainer.
volumeMounts

VolumeMount[]

Pemasangan volume kontainer.

Job

Pekerjaan Aplikasi Kontainer

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

ManagedServiceIdentity

Identitas terkelola yang diperlukan oleh pekerjaan aplikasi kontainer untuk berinteraksi dengan layanan Azure lainnya untuk tidak mempertahankan rahasia atau kredensial apa pun dalam kode.
location

string

Lokasi geografis tempat sumber daya berada
name

string

Nama sumber daya.
properties.configuration

JobConfiguration

Properti konfigurasi Pekerjaan Container Apps.
properties.environmentId

string

ID sumber daya lingkungan.
properties.eventStreamEndpoint

string

Titik akhir eventstream pekerjaan aplikasi kontainer.
properties.outboundIpAddresses

string[]

Alamat IP keluar dari pekerjaan aplikasi kontainer.
properties.provisioningState

JobProvisioningState

Status provisi Pekerjaan Aplikasi Kontainer.
properties.template

JobTemplate

Definisi kerja Aplikasi Kontainer.
properties.workloadProfileName

string

Nama profil beban kerja yang akan disematkan untuk eksekusi pekerjaan aplikasi kontainer.
systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
tags

object

Tag sumber daya.
type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

JobConfiguration

Properti konfigurasi Pekerjaan Aplikasi Kontainer non-versi

Nama Jenis Nilai Default Deskripsi
eventTriggerConfig

EventTriggerConfig

Memicu konfigurasi pekerjaan berbasis peristiwa.
manualTriggerConfig

ManualTriggerConfig

Konfigurasi pemicu manual untuk satu pekerjaan eksekusi. Properti replicaCompletionCount dan paralelisme akan diatur ke 1 secara default
registries

RegistryCredentials[]

Kumpulan kredensial registri kontainer privat yang digunakan oleh pekerjaan aplikasi Kontainer
replicaRetryLimit

integer

Jumlah maksimum percobaan ulang sebelum gagal dalam pekerjaan.
replicaTimeout

integer

Jumlah detik maksimum replika diizinkan untuk dijalankan.
scheduleTriggerConfig

ScheduleTriggerConfig

Cron memformat jadwal pemicu berulang ("* * * * *") untuk cronjobs. Penyelesaian properti dan paralelisme akan diatur ke 1 secara default
secrets

Secret[]

Kumpulan rahasia yang digunakan oleh Pekerjaan Aplikasi Kontainer
triggerType

TriggerType

Manual

Jenis pemicu pekerjaan

JobProvisioningState

Status provisi Pekerjaan Aplikasi Kontainer.

Nama Jenis Deskripsi
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

JobScale

Konfigurasi penskalaan untuk pekerjaan berbasis peristiwa.

Nama Jenis Nilai Default Deskripsi
maxExecutions

integer

100

Jumlah maksimum eksekusi pekerjaan yang dibuat untuk pemicu, default 100.
minExecutions

integer

0

Jumlah minimum eksekusi pekerjaan yang dibuat untuk pemicu, default 0
pollingInterval

integer

Interval untuk memeriksa setiap sumber peristiwa dalam hitungan detik. Default ke 30dtk
rules

JobScaleRule[]

Aturan penskalakan.

JobScaleRule

Aturan penskalakan.

Nama Jenis Deskripsi
auth

ScaleRuleAuth[]

Rahasia autentikasi untuk aturan skala.
metadata

object

Properti metadata untuk menjelaskan aturan skala.
name

string

Nama Aturan Skala
type

string

Jenis aturan skala misalnya: azure-servicebus, redis dll.

JobTemplate

Definisi aplikasi versi Container Apps Job. Menentukan status revisi yang diinginkan dari revisi yang tidak dapat diubah. Setiap perubahan pada bagian ini Akan mengakibatkan revisi baru dibuat

Nama Jenis Deskripsi
containers

Container[]

Daftar definisi kontainer untuk Aplikasi Kontainer.
initContainers

InitContainer[]

Daftar kontainer khusus yang berjalan sebelum kontainer aplikasi.
volumes

Volume[]

Daftar definisi volume untuk Aplikasi Kontainer.

ManagedServiceIdentity

Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)

Nama Jenis Deskripsi
principalId

string

ID perwakilan layanan dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
tenantId

string

ID penyewa dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
type

ManagedServiceIdentityType

Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
userAssignedIdentities

<string,  UserAssignedIdentity>

Identitas User-Assigned
Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan.

ManagedServiceIdentityType

Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).

Nama Jenis Deskripsi
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManualTriggerConfig

Konfigurasi pemicu manual untuk satu pekerjaan eksekusi. Properti replicaCompletionCount dan paralelisme akan diatur ke 1 secara default

Nama Jenis Deskripsi
parallelism

integer

Jumlah replika paralel pekerjaan yang dapat berjalan pada waktu tertentu.
replicaCompletionCount

integer

Jumlah minimum penyelesaian replika yang berhasil sebelum penyelesaian pekerjaan secara keseluruhan.

RegistryCredentials

Registri Privat Aplikasi Kontainer

Nama Jenis Deskripsi
identity

string

Identitas Terkelola yang digunakan untuk mengautentikasi dengan Azure Container Registry. Untuk identitas yang ditetapkan pengguna, gunakan ID Sumber Daya identitas lengkap yang ditetapkan pengguna. Untuk identitas yang ditetapkan sistem, gunakan 'sistem'
passwordSecretRef

string

Nama Rahasia yang berisi kata sandi masuk registri
server

string

Container Registry Server
username

string

Nama Pengguna Container Registry

ScaleRuleAuth

Rahasia Autentikasi untuk Aturan Skala

Nama Jenis Deskripsi
secretRef

string

Nama rahasia untuk menarik param autentikasi.
triggerParameter

string

Parameter Pemicu yang menggunakan rahasia

ScheduleTriggerConfig

Cron memformat jadwal pemicu berulang ("* * * * *") untuk cronjobs. Penyelesaian properti dan paralelisme akan diatur ke 1 secara default

Nama Jenis Deskripsi
cronExpression

string

Cron memformat jadwal berulang ("* * * * *") dari Pekerjaan Cron.
parallelism

integer

Jumlah replika paralel pekerjaan yang dapat berjalan pada waktu tertentu.
replicaCompletionCount

integer

Jumlah minimum penyelesaian replika yang berhasil sebelum penyelesaian pekerjaan secara keseluruhan.

Scheme

Skema yang digunakan untuk menyambungkan ke host. Default ke HTTP.

Nama Jenis Deskripsi
HTTP

string

HTTPS

string

Secret

Definisi rahasia.

Nama Jenis Deskripsi
identity

string

ID sumber daya identitas terkelola untuk mengautentikasi dengan Azure Key Vault, atau Sistem untuk menggunakan identitas yang ditetapkan sistem.
keyVaultUrl

string

URL Azure Key Vault menunjuk ke rahasia yang direferensikan oleh aplikasi kontainer.
name

string

Nama Rahasia.
value

string

Nilai Rahasia.

SecretVolumeItem

Rahasia untuk ditambahkan ke volume.

Nama Jenis Deskripsi
path

string

Jalur ke rahasia proyek. Jika tidak ada jalur yang disediakan, jalur default ke nama rahasia yang tercantum di secretRef.
secretRef

string

Nama rahasia Aplikasi Kontainer tempat menarik nilai rahasia.

StorageType

Jenis penyimpanan untuk volume. Jika tidak disediakan, gunakan EmptyDir.

Nama Jenis Deskripsi
AzureFile

string

EmptyDir

string

Secret

string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).
createdBy

string

Identitas yang membuat sumber daya.
createdByType

createdByType

Jenis identitas yang membuat sumber daya.
lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy

string

Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType

createdByType

Jenis identitas yang terakhir mengubah sumber daya.

TcpSocket

TCPSocket menentukan tindakan yang melibatkan port TCP. Kait TCP belum didukung.

Nama Jenis Deskripsi
host

string

Opsional: Nama host untuk disambungkan, default ke IP pod.
port

integer

Nomor atau nama port yang akan diakses pada kontainer. Angka harus dalam rentang 1 hingga 65535. Nama harus berupa IANA_SVC_NAME.

TriggerType

Jenis pemicu pekerjaan

Nama Jenis Deskripsi
Event

string

Manual

string

Schedule

string

Type

Jenis pemeriksaan.

Nama Jenis Deskripsi
Liveness

string

Readiness

string

Startup

string

UserAssignedIdentity

Properti identitas yang ditetapkan pengguna

Nama Jenis Deskripsi
clientId

string

ID klien dari identitas yang ditetapkan.
principalId

string

ID utama identitas yang ditetapkan.

Volume

Definisi volume untuk Aplikasi Kontainer.

Nama Jenis Deskripsi
mountOptions

string

Opsi pemasangan yang digunakan saat memasang AzureFile. Harus berupa string yang dipisahkan koma.
name

string

Nama volume.
secrets

SecretVolumeItem[]

Daftar rahasia yang akan ditambahkan dalam volume. Jika tidak ada rahasia yang disediakan, semua rahasia dalam koleksi akan ditambahkan ke volume.
storageName

string

Nama sumber daya penyimpanan. Tidak perlu menyediakan EmptyDir dan Rahasia.
storageType

StorageType

Jenis penyimpanan untuk volume. Jika tidak disediakan, gunakan EmptyDir.

VolumeMount

Pemasangan volume untuk Aplikasi Kontainer.

Nama Jenis Deskripsi
mountPath

string

Jalur dalam kontainer tempat volume harus dipasang. Tidak boleh berisi ':'.
subPath

string

Jalur dalam volume tempat volume kontainer harus dipasang. Default ke "" (akar volume).
volumeName

string

Ini harus cocok dengan Nama Volume.