Jobs - Get

Service:

Azure Container Apps

API Version:

2024-03-01

Získejte vlastnosti úlohy Container Apps.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
jobName	path	True	string	Název úlohy Regex pattern: ^[-\w\._\(\)]+$
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Job	OK.
Other Status Codes	DefaultErrorResponse	Běžná odpověď na chybu.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get Container Apps Job

Sample Request

HTTP

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"
          }
        }
      ]
    }
  }
}

Definice

Name	Description
Container	Definice kontejneru aplikace kontejneru
ContainerAppProbe	Sonda popisuje kontrolu stavu, která se má provést u kontejneru, aby se zjistilo, jestli je aktivní nebo připravený k příjmu provozu.
ContainerResources	Požadavky na prostředky kontejneru aplikace kontejneru
createdByType	Typ identity, která vytvořila prostředek.
DefaultErrorResponse	App Service chybovou odpověď.
Details	Podrobnosti nebo chyba
EnvironmentVar	Proměnná prostředí kontejneru aplikace kontejneru
Error	Model chyb.
EventTriggerConfig	Aktivace konfigurace úlohy řízené událostmi
HttpGet	HTTPGet určuje požadavek HTTP, který se má provést.
HttpHeaders	Vlastní hlavičky, které se mají nastavit v požadavku. HTTP umožňuje opakované hlavičky.
InitContainer	Definice kontejneru inicializační aplikace kontejneru
Job	Úloha aplikace kontejneru
JobConfiguration	Vlastnosti konfigurace úlohy Container Apps bez verzí
JobProvisioningState	Stav zřizování úlohy Container Apps
JobScale	Konfigurace škálování pro úlohy řízené událostmi
JobScaleRule	Pravidlo škálování.
JobTemplate	Definice aplikace s verzí úloh Container Apps Definuje požadovaný stav neměnné revize. Všechny změny v tomto oddílu budou mít za následek vytvoření nové revize.
ManagedServiceIdentity	Identita spravované služby (identity přiřazené systémem nebo uživatelem)
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned)
ManualTriggerConfig	Ruční konfigurace triggeru pro jednu úlohu spuštění Vlastnosti replicaCompletionCount a paralelismus by byly ve výchozím nastavení nastaveny na hodnotu 1.
RegistryCredentials	Privátní registr aplikace kontejneru
ScaleRuleAuth	Ověřovací tajné kódy pro pravidlo škálování
ScheduleTriggerConfig	Plán opakujících se aktivačních událostí ve formátu Cron (** * * *") pro cronjobs. Dokončování vlastností a paralelismus by ve výchozím nastavení byly nastaveny na hodnotu 1.
Scheme	Schéma, které se má použít pro připojení k hostiteli Výchozí hodnota je HTTP.
Secret	Definice tajného kódu
SecretVolumeItem	Tajný kód, který se má přidat do svazku.
StorageType	Typ úložiště pro svazek. Pokud není k dispozici, použijte EmptyDir.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
TcpSocket	TCPSocket určuje akci zahrnující port TCP. Připojení TCP zatím není podporováno.
TriggerType	Typ triggeru úlohy
Type	Typ sondy.
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem
Volume	Definice svazků pro aplikaci kontejneru
VolumeMount	Připojení svazku pro aplikaci kontejneru

Container

Definice kontejneru aplikace kontejneru

Name	Typ	Description
args	string[]	Argumenty příkazu spuštění kontejneru
command	string[]	Příkaz Pro spuštění kontejneru
env	EnvironmentVar[]	Proměnné prostředí kontejneru.
image	string	Značka image kontejneru.
name	string	Název vlastního kontejneru.
probes	ContainerAppProbe[]	Seznam sond pro kontejner
resources	ContainerResources	Požadavky na prostředky kontejneru.
volumeMounts	VolumeMount[]	Připojení svazku kontejneru.

ContainerAppProbe

Sonda popisuje kontrolu stavu, která se má provést u kontejneru, aby se zjistilo, jestli je aktivní nebo připravený k příjmu provozu.

Name	Typ	Description
failureThreshold	integer	Minimální počet po sobě jdoucích selhání sondy, které se mají považovat za neúspěšné po úspěšném provedení. Výchozí hodnota je 3. Minimální hodnota je 1. Maximální hodnota je 10.
httpGet	HttpGet	HTTPGet určuje požadavek HTTP, který se má provést.
initialDelaySeconds	integer	Počet sekund po spuštění kontejneru před zahájením sondy živosti Minimální hodnota je 1. Maximální hodnota je 60.
periodSeconds	integer	Jak často (v sekundách) se má sonda provádět. Výchozí hodnota je 10 sekund. Minimální hodnota je 1. Maximální hodnota je 240.
successThreshold	integer	Minimální počet po sobě jdoucích úspěchů, aby se sonda po neúspěchu považovala za úspěšnou. Výchozí hodnota je 1. Aby bylo možné spustit a spustit, musí být 1. Minimální hodnota je 1. Maximální hodnota je 10.
tcpSocket	TcpSocket	TCPSocket určuje akci zahrnující port TCP. Připojení TCP zatím není podporováno.
terminationGracePeriodSeconds	integer	Volitelná doba trvání v sekundách, po které se pod musí řádně ukončit při selhání sondy. Období odkladu je doba v sekundách od odeslání signálu ukončení procesů spuštěných v podu a doba, kdy jsou procesy vynuceně zastaveny signálem ukončení. Nastavte tuto hodnotu na delší dobu, než je očekávaná doba čištění procesu. Pokud je tato hodnota nil, použije se ukončenígracePeriodSeconds podu. V opačném případě tato hodnota přepíše hodnotu zadanou specifikací podu. Hodnota musí být nezáporné celé číslo. Hodnota nula indikuje okamžité zastavení prostřednictvím signálu kill (bez možnosti vypnutí). Toto je pole alfa a vyžaduje povolení brány funkce ProbeTerminationGracePeriod. Maximální hodnota je 3600 sekund (1 hodina)
timeoutSeconds	integer	Počet sekund, po jejichž uplynutí vyprší časový limit sondy. Výchozí hodnota je 1 sekunda. Minimální hodnota je 1. Maximální hodnota je 240.
type	Type	Typ sondy.

ContainerResources

Požadavky na prostředky kontejneru aplikace kontejneru

Name	Typ	Description
cpu	number	Požadovaný procesor v jádrech, například 0,5
ephemeralStorage	string	Dočasné úložiště, například "1Gi"
memory	string	Požadovaná paměť, například "250 MB"

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultErrorResponse

App Service chybovou odpověď.

Name	Typ	Description
error	Error	Model chyb.

Details

Podrobnosti nebo chyba

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

EnvironmentVar

Proměnná prostředí kontejneru aplikace kontejneru

Name	Typ	Description
name	string	Název proměnné prostředí.
secretRef	string	Název tajného klíče aplikace kontejneru, ze kterého se má načíst hodnota proměnné prostředí.
value	string	Hodnota proměnné prostředí, která není tajná.

Error

Model chyb.

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby
details	Details[]	Podrobnosti nebo chyba
innererror	string	Další informace o chybě ladění
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

EventTriggerConfig

Aktivace konfigurace úlohy řízené událostmi

Name	Typ	Description
parallelism	integer	Počet paralelních replik úlohy, které se dají spustit v daném okamžiku
replicaCompletionCount	integer	Minimální počet úspěšných dokončení replik před celkovým dokončením úlohy
scale	JobScale	Konfigurace škálování pro úlohy řízené událostmi

HttpGet

HTTPGet určuje požadavek HTTP, který se má provést.

Name	Typ	Description
host	string	Název hostitele, ke kterému se chcete připojit, se ve výchozím nastavení používá IP adresa podu. Pravděpodobně budete chtít nastavit "Host" v httpHeaders místo toho.
httpHeaders	HttpHeaders[]	Vlastní hlavičky, které se mají nastavit v požadavku. HTTP umožňuje opakované hlavičky.
path	string	Cesta k přístupu na serveru HTTP.
port	integer	Název nebo číslo portu pro přístup k kontejneru Číslo musí být v rozsahu 1 až 65535. Název musí být IANA_SVC_NAME.
scheme	Scheme	Schéma, které se má použít pro připojení k hostiteli Výchozí hodnota je HTTP.

HttpHeaders

Vlastní hlavičky, které se mají nastavit v požadavku. HTTP umožňuje opakované hlavičky.

Name	Typ	Description
name	string	Název pole záhlaví
value	string	Hodnota pole záhlaví

InitContainer

Definice kontejneru inicializační aplikace kontejneru

Name	Typ	Description
args	string[]	Argumenty příkazu pro spuštění kontejneru
command	string[]	Příkaz Pro spuštění kontejneru
env	EnvironmentVar[]	Proměnné prostředí kontejneru.
image	string	Značka image kontejneru.
name	string	Název vlastního kontejneru.
resources	ContainerResources	Požadavky na prostředky kontejneru
volumeMounts	VolumeMount[]	Připojení svazku kontejneru.

Job

Úloha aplikace kontejneru

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
identity	ManagedServiceIdentity	Spravované identity, které úloha aplikace kontejneru potřebuje k interakci s dalšími službami Azure, aby se neuchovávají žádné tajné kódy ani přihlašovací údaje v kódu.
location	string	Geografické umístění, kde se prostředek nachází
name	string	Název prostředku
properties.configuration	JobConfiguration	Vlastnosti konfigurace úlohy Container Apps
properties.environmentId	string	ID prostředku prostředí
properties.eventStreamEndpoint	string	Koncový bod streamu událostí úlohy aplikací kontejneru.
properties.outboundIpAddresses	string[]	Odchozí IP adresy úlohy aplikací kontejneru.
properties.provisioningState	JobProvisioningState	Stav zřizování úlohy Container Apps
properties.template	JobTemplate	Definice úlohy Container Apps
properties.workloadProfileName	string	Název profilu úlohy, který se má připnout pro provádění úloh aplikací kontejneru.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object	Značky prostředků.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

JobConfiguration

Vlastnosti konfigurace úlohy Container Apps bez verzí

Name	Typ	Výchozí hodnota	Description
eventTriggerConfig	EventTriggerConfig		Aktivace konfigurace úlohy řízené událostmi
manualTriggerConfig	ManualTriggerConfig		Ruční konfigurace triggeru pro jednu úlohu spuštění Vlastnosti replicaCompletionCount a paralelismus by byly ve výchozím nastavení nastaveny na hodnotu 1.
registries	RegistryCredentials[]		Kolekce přihlašovacích údajů privátního registru kontejneru používaná úlohou aplikací kontejneru
replicaRetryLimit	integer		Maximální počet opakování před selháním úlohy
replicaTimeout	integer		Maximální počet sekund, po který může replika běžet.
scheduleTriggerConfig	ScheduleTriggerConfig		Plán opakujících se aktivačních událostí ve formátu Cron (** * * *") pro cronjobs. Dokončování vlastností a paralelismus by ve výchozím nastavení byly nastaveny na hodnotu 1.
secrets	Secret[]		Kolekce tajných kódů používaných úlohou Aplikací kontejneru
triggerType	TriggerType	Manual	Typ triggeru úlohy

JobProvisioningState

Stav zřizování úlohy Container Apps

Name	Typ	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

JobScale

Konfigurace škálování pro úlohy řízené událostmi

Name	Typ	Výchozí hodnota	Description
maxExecutions	integer	100	Maximální počet spuštění úloh vytvořených pro trigger, výchozí 100.
minExecutions	integer	0	Minimální počet spuštění úloh vytvořených pro trigger, výchozí 0
pollingInterval	integer		Interval kontroly jednotlivých zdrojů událostí v sekundách Výchozí hodnota je 30s.
rules	JobScaleRule[]		Pravidla škálování.

JobScaleRule

Pravidlo škálování.

Name	Typ	Description
auth	ScaleRuleAuth[]	Tajné kódy ověřování pro pravidlo škálování.
metadata	object	Vlastnosti metadat, které popisují pravidlo škálování.
name	string	Název pravidla škálování
type	string	Typ pravidla škálování, např. azure-servicebus, redis atd.

JobTemplate

Definice aplikace s verzí úloh Container Apps Definuje požadovaný stav neměnné revize. Všechny změny v tomto oddílu budou mít za následek vytvoření nové revize.

Name	Typ	Description
containers	Container[]	Seznam definic kontejnerů pro aplikaci kontejneru
initContainers	InitContainer[]	Seznam specializovaných kontejnerů, které se spouští před kontejnery aplikací
volumes	Volume[]	Seznam definic svazků pro aplikaci kontejneru

ManagedServiceIdentity

Identita spravované služby (identity přiřazené systémem nebo uživatelem)

Name	Typ	Description
principalId	string	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytnuta pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta identity přiřazené systémem. Tato vlastnost bude poskytnuta pouze pro identitu přiřazenou systémem.
type	ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned)
userAssignedIdentities	<string,  UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružených k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formátu /subscriptions/{subscriptionId}/resourceGroups/{název_skupiny_prostředků}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned)

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManualTriggerConfig

Ruční konfigurace triggeru pro jednu úlohu spuštění Vlastnosti replicaCompletionCount a paralelismus by byly ve výchozím nastavení nastaveny na hodnotu 1.

Name	Typ	Description
parallelism	integer	Počet paralelních replik úlohy, které se dají spustit v daném okamžiku
replicaCompletionCount	integer	Minimální počet úspěšných dokončení replik před celkovým dokončením úlohy

RegistryCredentials

Privátní registr aplikace kontejneru

Name	Typ	Description
identity	string	Spravovaná identita, která se použije k ověřování pomocí Azure Container Registry. U identit přiřazených uživatelem použijte úplné ID prostředku identity přiřazené uživatelem. Pro identity přiřazené systémem použijte "system".
passwordSecretRef	string	Název tajného klíče, který obsahuje přihlašovací heslo registru
server	string	Container Registry Server
username	string	Uživatelské jméno registru kontejneru

ScaleRuleAuth

Ověřovací tajné kódy pro pravidlo škálování

Name	Typ	Description
secretRef	string	Název tajného kódu, ze kterého se mají načíst parametry ověřování.
triggerParameter	string	Parametr triggeru, který používá tajný klíč

ScheduleTriggerConfig

Plán opakujících se aktivačních událostí ve formátu Cron (** * * *") pro cronjobs. Dokončování vlastností a paralelismus by ve výchozím nastavení byly nastaveny na hodnotu 1.

Name	Typ	Description
cronExpression	string	Plán opakování ve formátu Cron (** * * *) úlohy Cron.
parallelism	integer	Počet paralelních replik úlohy, které se dají spustit v daném okamžiku
replicaCompletionCount	integer	Minimální počet úspěšných dokončení replik před celkovým dokončením úlohy

Scheme

Schéma, které se má použít pro připojení k hostiteli Výchozí hodnota je HTTP.

Name	Typ	Description
HTTP	string
HTTPS	string

Secret

Definice tajného kódu

Name	Typ	Description
identity	string	ID prostředku spravované identity k ověření pomocí Azure Key Vault nebo k použití identity přiřazené systémem.
keyVaultUrl	string	Adresa URL Key Vault Azure odkazující na tajný klíč, na který odkazuje aplikace kontejneru.
name	string	Název tajného kódu.
value	string	Hodnota tajného kódu.

SecretVolumeItem

Tajný kód, který se má přidat do svazku.

Name	Typ	Description
path	string	Cesta k promítaní tajného kódu do. Pokud není k dispozici žádná cesta, použije se ve výchozím nastavení název tajného klíče uvedený v secretRef.
secretRef	string	Název tajného klíče aplikace kontejneru, ze kterého se má načíst hodnota tajného klíče.

StorageType

Typ úložiště pro svazek. Pokud není k dispozici, použijte EmptyDir.

Name	Typ	Description
AzureFile	string
EmptyDir	string
Secret	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

TcpSocket

TCPSocket určuje akci zahrnující port TCP. Připojení TCP zatím není podporováno.

Name	Typ	Description
host	string	Volitelné: Název hostitele, ke kterému se chcete připojit, výchozí hodnota je IP adresa podu.
port	integer	Číslo nebo název portu pro přístup k kontejneru Číslo musí být v rozsahu 1 až 65535. Název musí být IANA_SVC_NAME.

TriggerType

Typ triggeru úlohy

Name	Typ	Description
Event	string
Manual	string
Schedule	string

Type

Typ sondy.

Name	Typ	Description
Liveness	string
Readiness	string
Startup	string

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string	ID klienta přiřazené identity.
principalId	string	ID objektu zabezpečení přiřazené identity.

Volume

Definice svazků pro aplikaci kontejneru

Name	Typ	Description
mountOptions	string	Možnosti připojení použité při připojování souboru AzureFile Musí to být řetězec oddělený čárkami.
name	string	Název svazku.
secrets	SecretVolumeItem[]	Seznam tajných kódů, které se mají přidat do svazku Pokud nejsou k dispozici žádné tajné kódy, budou všechny tajné kódy v kolekci přidány do svazku.
storageName	string	Název prostředku úložiště. Není nutné zadávat hodnoty EmptyDir a Secret.
storageType	StorageType	Typ úložiště pro svazek. Pokud není k dispozici, použijte EmptyDir.

VolumeMount

Připojení svazku pro aplikaci kontejneru

Name	Typ	Description
mountPath	string	Cesta v kontejneru, ke kterému se má svazek připojit. Nesmí obsahovat :.
subPath	string	Cesta v rámci svazku, ze kterého má být svazek kontejneru připojený. Výchozí hodnota je "" (kořen svazku).
volumeName	string	Musí se shodovat s názvem svazku.