Jobs - Get

Referentie

Service:: Azure Container Apps

API Version:: 2024-03-01

De eigenschappen van een Container Apps-taak ophalen.

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

URI-parameters

Name	In	Vereist	Type	Description
jobName	path	True	string	Taaknaam Regex pattern: `^[-\w\._]+$`
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	Job	OK.
Other Status Codes	DefaultErrorResponse	Veelvoorkomende foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name	Description
Container	Container-app-containerdefinitie
ContainerAppProbe	In de test wordt een statuscontrole beschreven die moet worden uitgevoerd op een container om te bepalen of deze actief is of klaar is om verkeer te ontvangen.
ContainerResources	Vereisten voor container-app-containerresources.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DefaultErrorResponse	App Service foutreactie.
Details	Details of de fout
EnvironmentVar	Container App-containeromgevingsvariabele.
Error	Foutmodel.
EventTriggerConfig	Triggerconfiguratie van een gebeurtenisgestuurde taak.
HttpGet	HTTPGet geeft de HTTP-aanvraag op die moet worden uitgevoerd.
HttpHeaders	Aangepaste headers die moeten worden ingesteld in de aanvraag. HTTP staat herhaalde headers toe.
InitContainer	Container App init-containerdefinitie
Job	Container App-taak
JobConfiguration	Configuratie-eigenschappen van container apps-taken zonder versie
JobProvisioningState	Inrichtingsstatus van de Container Apps-taak.
JobScale	Configuraties schalen voor gebeurtenisgestuurde taken.
JobScaleRule	Schaalregel.
JobTemplate	Definitie van toepassingsversie van Container Apps-taak. Hiermee definieert u de gewenste status van een onveranderbare revisie. Wijzigingen in deze sectie leiden ertoe dat er een nieuwe revisie wordt gemaakt
ManagedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)
ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel systemAssigned als UserAssigned zijn toegestaan).
ManualTriggerConfig	Handmatige triggerconfiguratie voor één uitvoeringstaak. Eigenschappen replicaCompletionCount en parallellisme worden standaard ingesteld op 1
RegistryCredentials	Privéregister van container-app
ScaleRuleAuth	Verificatiegeheimen voor schaalregel
ScheduleTriggerConfig	Schema voor herhalende triggers met Cron-opmaak ("* * * *") voor cronjobs. Voltooiingen van eigenschappen en parallellisme worden standaard ingesteld op 1
Scheme	Schema dat moet worden gebruikt om verbinding te maken met de host. De standaardinstelling is HTTP.
Secret	Geheime definitie.
SecretVolumeItem	Geheim dat moet worden toegevoegd aan het volume.
StorageType	Opslagtype voor het volume. Als dit niet is opgegeven, gebruikt u EmptyDir.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
TcpSocket	TCPSocket geeft een actie op met betrekking tot een TCP-poort. TCP-hooks worden nog niet ondersteund.
TriggerType	Triggertype van de taak
Type	Het type test.
UserAssignedIdentity	Eigenschappen van door de gebruiker toegewezen identiteit
Volume	Volumedefinities voor de Container App.
VolumeMount	Volumekoppeling voor de container-app.

Container

Container-app-containerdefinitie

Name	Type	Description
args	string[]	Argumenten voor containerstartopdrachten.
command	string[]	Container start opdracht.
env	EnvironmentVar[]	Containeromgevingsvariabelen.
image	string	Tag containerinstallatiekopieën.
name	string	Aangepaste containernaam.
probes	ContainerAppProbe[]	Lijst met tests voor de container.
resources	ContainerResources	Vereisten voor containerresources.
volumeMounts	VolumeMount[]	Containervolumekoppelingen.

ContainerAppProbe

In de test wordt een statuscontrole beschreven die moet worden uitgevoerd op een container om te bepalen of deze actief is of klaar is om verkeer te ontvangen.

Name	Type	Description
failureThreshold	integer	Minimale opeenvolgende fouten voor de test die moeten worden beschouwd als mislukt nadat ze zijn geslaagd. Standaardwaarde is 3. Minimumwaarde is 1. De maximumwaarde is 10.
httpGet	HttpGet	HTTPGet geeft de HTTP-aanvraag op die moet worden uitgevoerd.
initialDelaySeconds	integer	Aantal seconden nadat de container is gestart voordat de activiteitstests worden gestart. Minimumwaarde is 1. De maximumwaarde is 60.
periodSeconds	integer	Hoe vaak (in seconden) de test moet worden uitgevoerd. De standaardwaarde is 10 seconden. Minimumwaarde is 1. De maximumwaarde is 240.
successThreshold	integer	Minimale opeenvolgende successen om de test als geslaagd te beschouwen nadat deze is mislukt. Standaardwaarde is 1. Moet 1 zijn voor levendigheid en opstarten. Minimumwaarde is 1. De maximumwaarde is 10.
tcpSocket	TcpSocket	TCPSocket geeft een actie op met betrekking tot een TCP-poort. TCP-hooks worden nog niet ondersteund.
terminationGracePeriodSeconds	integer	Optionele duur in seconden dat de pod probleemloos moet worden beëindigd wanneer de test mislukt. De respijtperiode is de duur in seconden nadat de processen die in de pod worden uitgevoerd, een beëindigingssignaal hebben verzonden en het tijdstip waarop de processen geforceerd worden gestopt met een kill-signaal. Stel deze waarde langer in dan de verwachte opschoontijd voor uw proces. Als deze waarde nul is, wordt de terminationGracePeriodSeconds van de pod gebruikt. Anders overschrijft deze waarde de waarde die wordt geleverd door de podspecificatie. Waarde moet een niet-negatief geheel getal zijn. De waarde nul geeft stop onmiddellijk aan via het kill-signaal (geen mogelijkheid om af te sluiten). Dit is een alfaveld waarvoor de functiepoort ProbeTerminationGracePeriod moet worden ingeschakeld. De maximumwaarde is 3600 seconden (1 uur)
timeoutSeconds	integer	Het aantal seconden waarna er een time-out optreedt voor de test. De standaardinstelling is 1 seconde. Minimumwaarde is 1. De maximumwaarde is 240.
type	Type	Het type test.

ContainerResources

Vereisten voor container-app-containerresources.

Name	Type	Description
cpu	number	Vereiste CPU in kernen, bijvoorbeeld 0,5
ephemeralStorage	string	Tijdelijke opslag, bijvoorbeeld "1Gi"
memory	string	Vereist geheugen, bijvoorbeeld '250 Mb'

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultErrorResponse

App Service foutreactie.

Name	Type	Description
error	Error	Foutmodel.

Details

Details of de fout

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

EnvironmentVar

Container App-containeromgevingsvariabele.

Name	Type	Description
name	string	Naam van omgevingsvariabele.
secretRef	string	Naam van het container-app-geheim waaruit de waarde van de omgevingsvariabele moet worden opgehaald.
value	string	Waarde van niet-geheime omgevingsvariabele.

Error

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Details of de fout
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

EventTriggerConfig

Triggerconfiguratie van een gebeurtenisgestuurde taak.

Name	Type	Description
parallelism	integer	Het aantal parallelle replica's van een taak dat op een bepaald moment kan worden uitgevoerd.
replicaCompletionCount	integer	Minimumaantal geslaagde replicavoltooiingen voordat de algehele taak is voltooid.
scale	JobScale	Configuraties schalen voor gebeurtenisgestuurde taken.

HttpGet

HTTPGet geeft de HTTP-aanvraag op die moet worden uitgevoerd.

Name	Type	Description
host	string	Hostnaam waarmee verbinding moet worden gemaakt, is standaard ingesteld op het IP-adres van de pod. U wilt waarschijnlijk 'Host' instellen in httpHeaders.
httpHeaders	HttpHeaders[]	Aangepaste headers die moeten worden ingesteld in de aanvraag. HTTP staat herhaalde headers toe.
path	string	Pad naar toegang op de HTTP-server.
port	integer	Naam of nummer van de poort voor toegang tot de container. Het getal moet tussen 1 en 65535 liggen. De naam moet een IANA_SVC_NAME zijn.
scheme	Scheme	Schema dat moet worden gebruikt om verbinding te maken met de host. De standaardinstelling is HTTP.

HttpHeaders

Aangepaste headers die moeten worden ingesteld in de aanvraag. HTTP staat herhaalde headers toe.

Name	Type	Description
name	string	De veldnaam van de koptekst
value	string	De waarde van het veld Header

InitContainer

Container App init-containerdefinitie

Name	Type	Description
args	string[]	Argumenten voor containerstartopdrachten.
command	string[]	Containerstartopdracht.
env	EnvironmentVar[]	Containeromgevingsvariabelen.
image	string	Tag containerinstallatiekopieën.
name	string	Aangepaste containernaam.
resources	ContainerResources	Vereisten voor containerresources.
volumeMounts	VolumeMount[]	Containervolumekoppelingen.

Job

Container App-taak

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Beheerde identiteiten die een container-app-taak nodig heeft om te communiceren met andere Azure-services om geen geheimen of referenties in code te onderhouden.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.configuration	JobConfiguration	Eigenschappen van Container Apps-taakconfiguratie.
properties.environmentId	string	Resource-id van omgeving.
properties.eventStreamEndpoint	string	Het eindpunt van de gebeurtenisstroom van de container-apps-taak.
properties.outboundIpAddresses	string[]	Uitgaande IP-adressen van een container-apps-taak.
properties.provisioningState	JobProvisioningState	Inrichtingsstatus van de Container Apps-taak.
properties.template	JobTemplate	Container Apps-taakdefinitie.
properties.workloadProfileName	string	Naam van workloadprofiel om vast te maken voor taakuitvoering van container-apps.
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

JobConfiguration

Configuratie-eigenschappen van container apps-taken zonder versie

Name	Type	Standaardwaarde	Description
eventTriggerConfig	EventTriggerConfig		Triggerconfiguratie van een gebeurtenisgestuurde taak.
manualTriggerConfig	ManualTriggerConfig		Handmatige triggerconfiguratie voor één uitvoeringstaak. Eigenschappen replicaCompletionCount en parallellisme worden standaard ingesteld op 1
registries	RegistryCredentials[]		Verzameling van persoonlijke containerregisterreferenties die worden gebruikt door een Container Apps-taak
replicaRetryLimit	integer		Maximum aantal nieuwe pogingen voordat de taak mislukt.
replicaTimeout	integer		Het maximum aantal seconden dat een replica mag worden uitgevoerd.
scheduleTriggerConfig	ScheduleTriggerConfig		Schema voor herhalende triggers met Cron-opmaak ("* * * *") voor cronjobs. Voltooiingen van eigenschappen en parallellisme worden standaard ingesteld op 1
secrets	Secret[]		Verzameling geheimen die worden gebruikt door een Container Apps-taak
triggerType	TriggerType	Manual	Triggertype van de taak

JobProvisioningState

Inrichtingsstatus van de Container Apps-taak.

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

JobScale

Configuraties schalen voor gebeurtenisgestuurde taken.

Name	Type	Standaardwaarde	Description
maxExecutions	integer	100	Maximum aantal taakuitvoeringen dat wordt gemaakt voor een trigger, standaard 100.
minExecutions	integer	0	Minimum aantal taakuitvoeringen dat wordt gemaakt voor een trigger, standaard 0
pollingInterval	integer		Interval om elke gebeurtenisbron in seconden te controleren. Standaard ingesteld op 30s
rules	JobScaleRule[]		Schaalregels.

JobScaleRule

Schaalregel.

Name	Type	Description
auth	ScaleRuleAuth[]	Verificatiegeheimen voor de schaalregel.
metadata	object	Eigenschappen van metagegevens om de schaalregel te beschrijven.
name	string	Naam van schaalregel
type	string	Type schaalregel bijvoorbeeld: azure-servicebus, redis, enzovoort.

JobTemplate

Definitie van toepassingsversie van Container Apps-taak. Hiermee definieert u de gewenste status van een onveranderbare revisie. Wijzigingen in deze sectie leiden ertoe dat er een nieuwe revisie wordt gemaakt

Name	Type	Description
containers	Container[]	Lijst met containerdefinities voor de container-app.
initContainers	InitContainer[]	Lijst met gespecialiseerde containers die vóór app-containers worden uitgevoerd.
volumes	Volume[]	Lijst met volumedefinities voor de container-app.

ManagedServiceIdentity

Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)

Name	Type	Description
principalId	string	De service-principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
tenantId	string	De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
type	ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel systemAssigned als UserAssigned zijn toegestaan).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned-identiteiten De set door de gebruiker toegewezen identiteiten die zijn gekoppeld aan de resource. De userAssignedIdentities-woordenlijstsleutels zijn ARM-resource-id's in de vorm: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De woordenlijstwaarden kunnen lege objecten ({}) in aanvragen zijn.

ManagedServiceIdentityType

Type beheerde service-identiteit (waarbij zowel systemAssigned als UserAssigned zijn toegestaan).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManualTriggerConfig

Handmatige triggerconfiguratie voor één uitvoeringstaak. Eigenschappen replicaCompletionCount en parallellisme worden standaard ingesteld op 1

Name	Type	Description
parallelism	integer	Het aantal parallelle replica's van een taak dat op een bepaald moment kan worden uitgevoerd.
replicaCompletionCount	integer	Minimumaantal geslaagde replicavoltooiingen voordat de algehele taak is voltooid.

RegistryCredentials

Privéregister van container-app

Name	Type	Description
identity	string	Een beheerde identiteit voor verificatie met Azure Container Registry. Gebruik voor door de gebruiker toegewezen identiteiten de volledige door de gebruiker toegewezen id-id. Gebruik 'systeem' voor door het systeem toegewezen identiteiten
passwordSecretRef	string	De naam van het geheim dat het aanmeldingswachtwoord voor het register bevat
server	string	Container Registry Server
username	string	Gebruikersnaam containerregister

ScaleRuleAuth

Verificatiegeheimen voor schaalregel

Name	Type	Description
secretRef	string	Naam van het geheim waaruit de verificatieparameters moeten worden opgehaald.
triggerParameter	string	Triggerparameter die gebruikmaakt van het geheim

ScheduleTriggerConfig

Schema voor herhalende triggers met Cron-opmaak ("* * * *") voor cronjobs. Voltooiingen van eigenschappen en parallellisme worden standaard ingesteld op 1

Name	Type	Description
cronExpression	string	Met Cron opgemaakt herhalend schema ("* * * * *") van een Cron-taak.
parallelism	integer	Het aantal parallelle replica's van een taak dat op een bepaald moment kan worden uitgevoerd.
replicaCompletionCount	integer	Minimumaantal geslaagde replicavoltooiingen voordat de algehele taak is voltooid.

Scheme

Schema dat moet worden gebruikt om verbinding te maken met de host. De standaardinstelling is HTTP.

Name	Type	Description
HTTP	string
HTTPS	string

Secret

Geheime definitie.

Name	Type	Description
identity	string	Resource-id van een beheerde identiteit om te verifiëren met Azure Key Vault of Systeem om een door het systeem toegewezen identiteit te gebruiken.
keyVaultUrl	string	Azure Key Vault URL die verwijst naar het geheim waarnaar wordt verwezen door de container-app.
name	string	Geheime naam.
value	string	Geheime waarde.

SecretVolumeItem

Geheim dat moet worden toegevoegd aan het volume.

Name	Type	Description
path	string	Pad naar projectgeheim naar. Als er geen pad is opgegeven, wordt het pad standaard ingesteld op de naam van het geheim dat wordt vermeld in secretRef.
secretRef	string	Naam van het container-app-geheim waaruit de geheime waarde moet worden opgehaald.

StorageType

Opslagtype voor het volume. Als dit niet is opgegeven, gebruikt u EmptyDir.

Name	Type	Description
AzureFile	string
EmptyDir	string
Secret	string

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

TcpSocket

TCPSocket geeft een actie op met betrekking tot een TCP-poort. TCP-hooks worden nog niet ondersteund.

Name	Type	Description
host	string	Optioneel: hostnaam waarmee verbinding moet worden gemaakt, standaard ingesteld op het IP-adres van de pod.
port	integer	Nummer of naam van de poort voor toegang tot de container. Het getal moet tussen 1 en 65535 liggen. De naam moet een IANA_SVC_NAME zijn.

TriggerType

Triggertype van de taak

Name	Type	Description
Event	string
Manual	string
Schedule	string

Type

Het type test.

Name	Type	Description
Liveness	string
Readiness	string
Startup	string

UserAssignedIdentity

Eigenschappen van door de gebruiker toegewezen identiteit

Name	Type	Description
clientId	string	De client-id van de toegewezen identiteit.
principalId	string	De principal-id van de toegewezen identiteit.

Volume

Volumedefinities voor de Container App.

Name	Type	Description
mountOptions	string	Koppelingsopties die worden gebruikt tijdens het koppelen van de AzureFile. Moet een door komma's gescheiden tekenreeks zijn.
name	string	Volumenaam.
secrets	SecretVolumeItem[]	Lijst met geheimen die in volume moeten worden toegevoegd. Als er geen geheimen worden opgegeven, worden alle geheimen in de verzameling toegevoegd aan het volume.
storageName	string	Naam van opslagresource. U hoeft geen EmptyDir en Secret op te geven.
storageType	StorageType	Opslagtype voor het volume. Als dit niet is opgegeven, gebruikt u EmptyDir.

VolumeMount

Volumekoppeling voor de container-app.

Name	Type	Description
mountPath	string	Pad binnen de container waaraan het volume moet worden gekoppeld. Mag geen ':' bevatten.
subPath	string	Pad binnen het volume waaruit het volume van de container moet worden gekoppeld. De standaardinstelling is '' (de hoofdmap van het volume).
volumeName	string	Dit moet overeenkomen met de naam van een volume.

Delen via