Jobs - Get
Hämta egenskaperna för ett Container Apps-jobb.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}?api-version=2024-03-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
job
|
path | True |
string |
Jobbnamn Reguljärt uttrycksmönster: |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Vanligt felsvar. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Get Container Apps Job
Exempelbegäran
Exempelsvar
{
"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"
}
}
]
}
}
}
Definitioner
Name | Description |
---|---|
Container |
Containerappens containerdefinition |
Container |
Avsökningen beskriver en hälsokontroll som ska utföras mot en container för att avgöra om den är aktiv eller redo att ta emot trafik. |
Container |
Resurskrav för containerappar. |
created |
Den typ av identitet som skapade resursen. |
Default |
App Service felsvar. |
Details |
Information eller felet |
Environment |
Miljövariabel för containerappen. |
Error |
Felmodell. |
Event |
Utlösa konfiguration av ett händelsedrivet jobb. |
Http |
HTTPGet anger http-begäran som ska utföras. |
Http |
Anpassade rubriker som ska anges i begäran. HTTP tillåter upprepade rubriker. |
Init |
Container App init containerdefinition |
Job |
Containerappjobb |
Job |
Konfigurationsegenskaper för containerappar som inte har version |
Job |
Etableringstillstånd för Container Apps-jobbet. |
Job |
Skalningskonfigurationer för händelsedrivna jobb. |
Job |
Skalningsregel. |
Job |
Container Apps Job versioned application definition. Definierar önskat tillstånd för en oföränderlig revision. Ändringar i det här avsnittet resulterar i att en ny revision skapas |
Managed |
Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter) |
Managed |
Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). |
Manual |
Manuell utlösarkonfiguration för ett enda körningsjobb. Egenskaper replicaCompletionCount och parallellitet skulle anges till 1 som standard |
Registry |
Privat register för containerapp |
Scale |
Autentiseringshemligheter för skalningsregel |
Schedule |
Cron formaterade upprepande utlösarschema ("* * * * *") för cronjobs. Egenskapers slutföranden och parallellitet skulle anges till 1 som standard |
Scheme |
Schema som ska användas för att ansluta till värden. Standardvärdet är HTTP. |
Secret |
Hemlig definition. |
Secret |
Hemlighet som ska läggas till i volymen. |
Storage |
Lagringstyp för volymen. Om inget anges använder du EmptyDir. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
Tcp |
TCPSocket anger en åtgärd som involverar en TCP-port. TCP-krokar stöds inte ännu. |
Trigger |
Utlösartyp för jobbet |
Type |
Typ av avsökning. |
User |
Användartilldelade identitetsegenskaper |
Volume |
Volymdefinitioner för containerappen. |
Volume |
Volymmontering för containerappen. |
Container
Containerappens containerdefinition
Name | Typ | Description |
---|---|---|
args |
string[] |
Kommandoargument för containerstart. |
command |
string[] |
Startkommando för container. |
env |
Miljövariabler för containrar. |
|
image |
string |
Containeravbildningstagg. |
name |
string |
Anpassat containernamn. |
probes |
Lista över avsökningar för containern. |
|
resources |
Krav för containerresurser. |
|
volumeMounts |
Containervolymmonteringar. |
ContainerAppProbe
Avsökningen beskriver en hälsokontroll som ska utföras mot en container för att avgöra om den är aktiv eller redo att ta emot trafik.
Name | Typ | Description |
---|---|---|
failureThreshold |
integer |
Minsta efterföljande fel för avsökningen som ska betraktas som misslyckad efter att ha lyckats. Standardvärdet är 3. Minsta värde är 1. Maximalt värde är 10. |
httpGet |
HTTPGet anger http-begäran som ska utföras. |
|
initialDelaySeconds |
integer |
Antal sekunder efter att containern har startats innan live-avsökningar initieras. Minsta värde är 1. Maximalt värde är 60. |
periodSeconds |
integer |
Hur ofta (i sekunder) avsökningen ska utföras. Standardvärdet är 10 sekunder. Minsta värde är 1. Maximalt värde är 240. |
successThreshold |
integer |
Minsta lyckade resultat i följd för att avsökningen ska anses vara lyckad efter att ha misslyckats. Standardvärdet är 1. Måste vara 1 för liveness och start. Minsta värde är 1. Maximalt värde är 10. |
tcpSocket |
TCPSocket anger en åtgärd som involverar en TCP-port. TCP-krokar stöds inte ännu. |
|
terminationGracePeriodSeconds |
integer |
Valfri varaktighet i sekunder podden måste avslutas på ett smidigt sätt vid avsökningsfel. Respitperioden är varaktigheten i sekunder efter att processerna som körs i podden har skickats en avslutssignal och den tid då processerna med två skäl stoppas med en killsignal. Ange det här värdet längre än den förväntade rensningstiden för processen. Om det här värdet är noll används poddens avslutningGracePeriodSeconds. Annars åsidosätter det här värdet värdet som tillhandahålls av poddspecifikationen. Värdet måste vara ett icke-negativt heltal. Värdet noll anger stopp omedelbart via avlivningssignalen (ingen möjlighet att stänga av). Det här är ett alfafält och kräver att funktionen ProbeTerminationGracePeriod aktiveras. Maximalt värde är 3 600 sekunder (1 timme) |
timeoutSeconds |
integer |
Antal sekunder som avsökningen överskrider tidsgränsen. Standardvärdet är 1 sekund. Minsta värde är 1. Maximalt värde är 240. |
type |
Typ av avsökning. |
ContainerResources
Resurskrav för containerappar.
Name | Typ | Description |
---|---|---|
cpu |
number |
Nödvändig processor i kärnor, t.ex. 0,5 |
ephemeralStorage |
string |
Tillfällig lagring, t.ex. "1Gi" |
memory |
string |
Nödvändigt minne, t.ex. "250 Mb" |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultErrorResponse
App Service felsvar.
Name | Typ | Description |
---|---|---|
error |
Felmodell. |
Details
Information eller felet
Name | Typ | Description |
---|---|---|
code |
string |
Standardiserad sträng för att programmässigt identifiera felet. |
message |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
target |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
EnvironmentVar
Miljövariabel för containerappen.
Name | Typ | Description |
---|---|---|
name |
string |
Miljövariabelnamn. |
secretRef |
string |
Namnet på containerappens hemlighet som miljövariabelvärdet ska hämtas från. |
value |
string |
Variabelvärde för icke-hemlig miljö. |
Error
Felmodell.
Name | Typ | Description |
---|---|---|
code |
string |
Standardiserad sträng för att programmässigt identifiera felet. |
details |
Details[] |
Information eller felet |
innererror |
string |
Mer information om felsökningsfel. |
message |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
target |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
EventTriggerConfig
Utlösa konfiguration av ett händelsedrivet jobb.
Name | Typ | Description |
---|---|---|
parallelism |
integer |
Antal parallella repliker av ett jobb som kan köras vid en viss tidpunkt. |
replicaCompletionCount |
integer |
Minsta antal slutförda repliker innan det totala jobbet slutförs. |
scale |
Skalningskonfigurationer för händelsedrivna jobb. |
HttpGet
HTTPGet anger http-begäran som ska utföras.
Name | Typ | Description |
---|---|---|
host |
string |
Värdnamn att ansluta till, standardvärdet för poddens IP-adress. Du vill förmodligen ange "Värd" i httpHeaders i stället. |
httpHeaders |
Anpassade rubriker som ska anges i begäran. HTTP tillåter upprepade rubriker. |
|
path |
string |
Sökväg till åtkomst på HTTP-servern. |
port |
integer |
Namn eller nummer på porten som ska kommas åt i containern. Talet måste ligga i intervallet 1 till 65535. Namnet måste vara en IANA_SVC_NAME. |
scheme |
Schema som ska användas för att ansluta till värden. Standardvärdet är HTTP. |
HttpHeaders
Anpassade rubriker som ska anges i begäran. HTTP tillåter upprepade rubriker.
Name | Typ | Description |
---|---|---|
name |
string |
Namn på rubrikfält |
value |
string |
Värdet för rubrikfält |
InitContainer
Container App init containerdefinition
Name | Typ | Description |
---|---|---|
args |
string[] |
Kommandoargument för containerstart. |
command |
string[] |
Startkommando för container. |
env |
Miljövariabler för containrar. |
|
image |
string |
Containeravbildningstagg. |
name |
string |
Anpassat containernamn. |
resources |
Krav för containerresurser. |
|
volumeMounts |
Containervolymmonteringar. |
Job
Containerappjobb
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Hanterade identiteter som krävs av ett containerappjobb för att interagera med andra Azure-tjänster för att inte upprätthålla några hemligheter eller autentiseringsuppgifter i kod. |
|
location |
string |
Den geo-plats där resursen finns |
name |
string |
Namnet på resursen |
properties.configuration |
Konfigurationsegenskaper för Container Apps-jobb. |
|
properties.environmentId |
string |
Resurs-ID för miljön. |
properties.eventStreamEndpoint |
string |
Slutpunkten för händelseströmmen för containerappsjobbet. |
properties.outboundIpAddresses |
string[] |
Utgående IP-adresser för ett containerappjobb. |
properties.provisioningState |
Etableringstillstånd för Container Apps-jobbet. |
|
properties.template |
Jobbdefinition för Container Apps. |
|
properties.workloadProfileName |
string |
Namn på arbetsbelastningsprofil som ska fästas för jobbkörning av containerappar. |
systemData |
Azure Resource Manager metadata som innehåller createdBy och modifiedBy information. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
JobConfiguration
Konfigurationsegenskaper för containerappar som inte har version
Name | Typ | Standardvärde | Description |
---|---|---|---|
eventTriggerConfig |
Utlösa konfiguration av ett händelsedrivet jobb. |
||
manualTriggerConfig |
Manuell utlösarkonfiguration för ett enda körningsjobb. Egenskaper replicaCompletionCount och parallellitet skulle anges till 1 som standard |
||
registries |
Insamling av autentiseringsuppgifter för privata containerregister som används av ett Container Apps-jobb |
||
replicaRetryLimit |
integer |
Maximalt antal återförsök innan jobbet misslyckas. |
|
replicaTimeout |
integer |
Maximalt antal sekunder som en replik tillåts köras. |
|
scheduleTriggerConfig |
Cron formaterade upprepande utlösarschema ("* * * * *") för cronjobs. Egenskapers slutföranden och parallellitet skulle anges till 1 som standard |
||
secrets |
Secret[] |
Insamling av hemligheter som används av ett Container Apps-jobb |
|
triggerType | Manual |
Utlösartyp för jobbet |
JobProvisioningState
Etableringstillstånd för Container Apps-jobbet.
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
JobScale
Skalningskonfigurationer för händelsedrivna jobb.
Name | Typ | Standardvärde | Description |
---|---|---|---|
maxExecutions |
integer |
100 |
Maximalt antal jobbkörningar som skapas för en utlösare, standard 100. |
minExecutions |
integer |
0 |
Minsta antal jobbkörningar som skapas för en utlösare, standard 0 |
pollingInterval |
integer |
Intervall för att kontrollera varje händelsekälla i sekunder. Standardvärdet är 30-talet |
|
rules |
Skalningsregler. |
JobScaleRule
Skalningsregel.
Name | Typ | Description |
---|---|---|
auth |
Autentiseringshemligheter för skalningsregeln. |
|
metadata |
object |
Metadataegenskaper för att beskriva skalningsregeln. |
name |
string |
Skalningsregelnamn |
type |
string |
Typ av skalningsregel, t.ex. azure-servicebus, redis osv. |
JobTemplate
Container Apps Job versioned application definition. Definierar önskat tillstånd för en oföränderlig revision. Ändringar i det här avsnittet resulterar i att en ny revision skapas
Name | Typ | Description |
---|---|---|
containers |
Lista över containerdefinitioner för containerappen. |
|
initContainers |
Lista över specialiserade containrar som körs före appcontainrar. |
|
volumes |
Volume[] |
Lista över volymdefinitioner för containerappen. |
ManagedServiceIdentity
Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
Name | Typ | Description |
---|---|---|
principalId |
string |
Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet. |
tenantId |
string |
Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet. |
type |
Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). |
|
userAssignedIdentities |
<string,
User |
User-Assigned identiteter |
ManagedServiceIdentityType
Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
Name | Typ | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
ManualTriggerConfig
Manuell utlösarkonfiguration för ett enda körningsjobb. Egenskaper replicaCompletionCount och parallellitet skulle anges till 1 som standard
Name | Typ | Description |
---|---|---|
parallelism |
integer |
Antal parallella repliker av ett jobb som kan köras vid en viss tidpunkt. |
replicaCompletionCount |
integer |
Minsta antal slutförda repliker innan det totala jobbet slutförs. |
RegistryCredentials
Privat register för containerapp
Name | Typ | Description |
---|---|---|
identity |
string |
En hanterad identitet som ska användas för att autentisera med Azure Container Registry. Använd det fullständiga användartilldelade identitetsresurs-ID:t för användartilldelade identiteter. För systemtilldelade identiteter använder du "system" |
passwordSecretRef |
string |
Namnet på hemligheten som innehåller lösenordet för registerinloggning |
server |
string |
Container Registry Server |
username |
string |
Användarnamn för containerregistret |
ScaleRuleAuth
Autentiseringshemligheter för skalningsregel
Name | Typ | Description |
---|---|---|
secretRef |
string |
Namnet på hemligheten som autentiseringsparamerna ska hämtas från. |
triggerParameter |
string |
Utlösarparameter som använder hemligheten |
ScheduleTriggerConfig
Cron formaterade upprepande utlösarschema ("* * * * *") för cronjobs. Egenskapers slutföranden och parallellitet skulle anges till 1 som standard
Name | Typ | Description |
---|---|---|
cronExpression |
string |
Cron formaterade upprepande schema ("* * * * *") för ett Cron-jobb. |
parallelism |
integer |
Antal parallella repliker av ett jobb som kan köras vid en viss tidpunkt. |
replicaCompletionCount |
integer |
Minsta antal slutförda repliker innan det totala jobbet slutförs. |
Scheme
Schema som ska användas för att ansluta till värden. Standardvärdet är HTTP.
Name | Typ | Description |
---|---|---|
HTTP |
string |
|
HTTPS |
string |
Secret
Hemlig definition.
Name | Typ | Description |
---|---|---|
identity |
string |
Resurs-ID för en hanterad identitet för autentisering med Azure Key Vault eller System för att använda en systemtilldelad identitet. |
keyVaultUrl |
string |
Azure Key Vault URL som pekar på hemligheten som refereras av containerappen. |
name |
string |
Hemligt namn. |
value |
string |
Hemligt värde. |
SecretVolumeItem
Hemlighet som ska läggas till i volymen.
Name | Typ | Description |
---|---|---|
path |
string |
Sökväg till projekthemlighet till. Om ingen sökväg anges anges standardsökvägen till namnet på hemligheten som anges i secretRef. |
secretRef |
string |
Namnet på containerappens hemlighet som det hemliga värdet ska hämtas från. |
StorageType
Lagringstyp för volymen. Om inget anges använder du EmptyDir.
Name | Typ | Description |
---|---|---|
AzureFile |
string |
|
EmptyDir |
string |
|
Secret |
string |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
TcpSocket
TCPSocket anger en åtgärd som involverar en TCP-port. TCP-krokar stöds inte ännu.
Name | Typ | Description |
---|---|---|
host |
string |
Valfritt: Värdnamn att ansluta till, standardvärdet för podd-IP-adressen. |
port |
integer |
Nummer eller namn på porten som ska kommas åt i containern. Talet måste vara mellan 1 och 65535. Namnet måste vara ett IANA_SVC_NAME. |
TriggerType
Utlösartyp för jobbet
Name | Typ | Description |
---|---|---|
Event |
string |
|
Manual |
string |
|
Schedule |
string |
Type
Typ av avsökning.
Name | Typ | Description |
---|---|---|
Liveness |
string |
|
Readiness |
string |
|
Startup |
string |
UserAssignedIdentity
Användartilldelade identitetsegenskaper
Name | Typ | Description |
---|---|---|
clientId |
string |
Klient-ID för den tilldelade identiteten. |
principalId |
string |
Huvud-ID för den tilldelade identiteten. |
Volume
Volymdefinitioner för containerappen.
Name | Typ | Description |
---|---|---|
mountOptions |
string |
Monteringsalternativ som används vid montering av AzureFile. Måste vara en kommaavgränsad sträng. |
name |
string |
Volymnamn. |
secrets |
Lista över hemligheter som ska läggas till i volymen. Om inga hemligheter anges läggs alla hemligheter i samlingen till i volymen. |
|
storageName |
string |
Namnet på lagringsresursen. Du behöver inte ange EmptyDir och Secret. |
storageType |
Lagringstyp för volymen. Om inget anges använder du EmptyDir. |
VolumeMount
Volymmontering för containerappen.
Name | Typ | Description |
---|---|---|
mountPath |
string |
Sökväg i containern där volymen ska monteras. Får inte innehålla :. |
subPath |
string |
Sökväg inom volymen som containerns volym ska monteras från. Standardvärdet är "" (volymens rot). |
volumeName |
string |
Detta måste matcha namnet på en volym. |