Partager via

Jobs - Get

  • Référence
Service:
Azure Container Apps
Version d'API:
2024-03-01

Obtenez les propriétés d’un travail Container Apps.

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

Paramètres URI

Nom Dans Obligatoire Type Description
jobName
 path True

string

Nom du travail

Modèle d’expression régulière: ^[-\w\._\(\)]+$
resourceGroupName
 path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId
 path True

string

ID de l’abonnement cible.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

Job

OK.
Other Status Codes

DefaultErrorResponse

Réponse d’erreur courante.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Get Container Apps Job

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
          }
        }
      ]
    }
  }
}

Définitions

Nom Description
Container

Définition de conteneur d’application conteneur
ContainerAppProbe

La sonde décrit un case activée d’intégrité à effectuer sur un conteneur pour déterminer s’il est actif ou prêt à recevoir du trafic.
ContainerResources

Exigences en matière de ressources de conteneur d’application conteneur.
createdByType

Type d’identité qui a créé la ressource.
DefaultErrorResponse

App Service réponse d’erreur.
Details

Détails ou erreur
EnvironmentVar

Variable d’environnement de conteneur Container App.
Error

Modèle d’erreur.
EventTriggerConfig

Déclencher la configuration d’un travail piloté par les événements.
HttpGet

HTTPGet spécifie la requête HTTP à effectuer.
HttpHeaders

En-têtes personnalisés à définir dans la demande. HTTP autorise les en-têtes répétés.
InitContainer

Définition de conteneur d’initialité d’application de conteneur
Job

Travail d’application conteneur
JobConfiguration

Propriétés de configuration du travail Container Apps sans version
JobProvisioningState

État d’approvisionnement du travail Container Apps.
JobScale

Mise à l’échelle des configurations pour les travaux pilotés par les événements.
JobScaleRule

Règle de mise à l’échelle.
JobTemplate

Container Apps Définition d’application avec version de travail. Définit l’état souhaité d’une révision immuable. Toute modification apportée à cette section entraîne la création d’une nouvelle révision
ManagedServiceIdentity

Identité de service managée (identités affectées par le système et/ou par l’utilisateur)
ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
ManualTriggerConfig

Configuration manuelle du déclencheur pour un travail d’exécution unique. Les propriétés replicaCompletionCount et le parallélisme sont définis sur 1 par défaut
RegistryCredentials

Registre privé de l’application conteneur
ScaleRuleAuth

Secrets d’authentification pour la règle d’échelle
ScheduleTriggerConfig

Planification du déclencheur répétiteur au format Cron (« * * * * * ») pour cronjobs. Les complétions et le parallélisme des propriétés seraient définis sur 1 par défaut
Scheme

Schéma à utiliser pour la connexion à l’hôte. La valeur par défaut est HTTP.
Secret

Définition de secret.
SecretVolumeItem

Secret à ajouter au volume.
StorageType

Type de stockage pour le volume. Si ce n’est pas le cas, utilisez EmptyDir.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
TcpSocket

TCPSocket spécifie une action impliquant un port TCP. Les hooks TCP ne sont pas encore pris en charge.
TriggerType

Type de déclencheur du travail
Type

Type de sonde.
UserAssignedIdentity

Propriétés de l’identité affectée par l’utilisateur
Volume

Définitions de volume pour l’application conteneur.
VolumeMount

Montage de volume pour l’application conteneur.

Container

Définition de conteneur d’application conteneur

Nom Type Description
args

string[]

Arguments de commande de démarrage du conteneur.
command

string[]

Commande de démarrage du conteneur.
env

EnvironmentVar[]

Variables d’environnement de conteneur.
image

string

Balise d’image conteneur.
name

string

Nom du conteneur personnalisé.
probes

ContainerAppProbe[]

Liste des sondes pour le conteneur.
resources

ContainerResources

Besoins en ressources de conteneur.
volumeMounts

VolumeMount[]

Montages de volumes de conteneur.

ContainerAppProbe

La sonde décrit un case activée d’intégrité à effectuer sur un conteneur pour déterminer s’il est actif ou prêt à recevoir du trafic.

Nom Type Description
failureThreshold

integer

Nombre minimal d’échecs consécutifs pour la sonde à considérer comme ayant échoué après avoir réussi. La valeur par défaut est 3. La valeur minimale est 1. La valeur maximale est 10.
httpGet

HttpGet

HTTPGet spécifie la requête HTTP à effectuer.
initialDelaySeconds

integer

Nombre de secondes après le démarrage du conteneur avant le lancement des probes liveness. La valeur minimale est 1. La valeur maximale est 60.
periodSeconds

integer

Fréquence (en secondes) d’exécution de la probe. La valeur par défaut est 10 secondes. La valeur minimale est 1. La valeur maximale est 240.
successThreshold

integer

Nombre minimal de réussites consécutives pour que la sonde soit considérée comme réussie après l’échec. La valeur par défaut est de 1. Doit être 1 pour l’liveness et le démarrage. La valeur minimale est 1. La valeur maximale est 10.
tcpSocket

TcpSocket

TCPSocket spécifie une action impliquant un port TCP. Les hooks TCP ne sont pas encore pris en charge.
terminationGracePeriodSeconds

integer

Durée facultative en secondes dont le pod doit se terminer normalement en cas d’échec de la sonde. La période de grâce correspond à la durée en secondes après l’envoi d’un signal d’arrêt aux processus en cours d’exécution dans le pod et au moment où les processus sont arrêtés de force avec un signal d’arrêt. Définissez cette valeur plus longtemps que le temps de nettoyage prévu pour votre processus. Si cette valeur est nulle, le paramètre terminationGracePeriodSeconds du pod est utilisé. Sinon, cette valeur remplace la valeur fournie par la spécification du pod. La valeur doit être un entier non négatif. La valeur zéro indique l’arrêt immédiat via le signal d’arrêt (aucune possibilité de s’arrêter). Il s’agit d’un champ alpha qui nécessite l’activation de la porte de fonctionnalité ProbeTerminationGracePeriod. La valeur maximale est de 3600 secondes (1 heure)
timeoutSeconds

integer

Nombre de secondes après lesquelles la sonde expire. La valeur par défaut est 1 seconde. La valeur minimale est 1. La valeur maximale est 240.
type

Type

Type de sonde.

ContainerResources

Exigences en matière de ressources de conteneur d’application conteneur.

Nom Type Description
cpu

number

Processeur requis dans les cœurs, par exemple 0,5
ephemeralStorage

string

Stockage éphémère, par exemple « 1Gi »
memory

string

Mémoire requise, par exemple « 250 Mo »

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultErrorResponse

App Service réponse d’erreur.

Nom Type Description
error

Error

Modèle d’erreur.

Details

Détails ou erreur

Nom Type Description
code

string

Chaîne standardisée pour identifier l’erreur par programmation.
message

string

Description détaillée de l’erreur et informations de débogage.
target

string

Description détaillée de l’erreur et informations de débogage.

EnvironmentVar

Variable d’environnement de conteneur Container App.

Nom Type Description
name

string

Nom de la variable d'environnement.
secretRef

string

Nom du secret Container App à partir duquel extraire la valeur de la variable d’environnement.
value

string

Valeur de variable d’environnement non secrète.

Error

Modèle d’erreur.

Nom Type Description
code

string

Chaîne standardisée pour identifier l’erreur par programmation.
details

Details[]

Détails ou erreur
innererror

string

Informations supplémentaires pour déboguer l’erreur.
message

string

Description détaillée de l’erreur et informations de débogage.
target

string

Description détaillée de l’erreur et informations de débogage.

EventTriggerConfig

Déclencher la configuration d’un travail piloté par les événements.

Nom Type Description
parallelism

integer

Nombre de réplicas parallèles d’un travail pouvant s’exécuter à un moment donné.
replicaCompletionCount

integer

Nombre minimal d’achèvements de réplica réussis avant l’achèvement global du travail.
scale

JobScale

Mise à l’échelle des configurations pour les travaux pilotés par les événements.

HttpGet

HTTPGet spécifie la requête HTTP à effectuer.

Nom Type Description
host

string

Nom d’hôte auquel se connecter, valeur par défaut de l’adresse IP du pod. Vous souhaiterez probablement définir « Hôte » dans httpHeaders à la place.
httpHeaders

HttpHeaders[]

En-têtes personnalisés à définir dans la demande. HTTP autorise les en-têtes répétés.
path

string

Chemin d’accès sur le serveur HTTP.
port

integer

Nom ou numéro du port auquel accéder sur le conteneur. Le nombre doit être compris entre 1 et 65535. Le nom doit être un IANA_SVC_NAME.
scheme

Scheme

Schéma à utiliser pour la connexion à l’hôte. La valeur par défaut est HTTP.

HttpHeaders

En-têtes personnalisés à définir dans la demande. HTTP autorise les en-têtes répétés.

Nom Type Description
name

string

Nom du champ d’en-tête
value

string

Valeur du champ d’en-tête

InitContainer

Définition de conteneur d’initialité d’application de conteneur

Nom Type Description
args

string[]

Arguments de commande de démarrage du conteneur.
command

string[]

Commande de démarrage du conteneur.
env

EnvironmentVar[]

Variables d’environnement de conteneur.
image

string

Balise d’image conteneur.
name

string

Nom du conteneur personnalisé.
resources

ContainerResources

Besoins en ressources de conteneur.
volumeMounts

VolumeMount[]

Montages de volumes de conteneur.

Job

Travail d’application conteneur

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

ManagedServiceIdentity

Identités managées nécessaires à un travail d’application conteneur pour interagir avec d’autres services Azure afin de ne pas conserver de secrets ou d’informations d’identification dans le code.
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties.configuration

JobConfiguration

Propriétés de configuration du travail Container Apps.
properties.environmentId

string

ID de ressource de l’environnement.
properties.eventStreamEndpoint

string

Point de terminaison du flux d’événements du travail d’applications conteneur.
properties.outboundIpAddresses

string[]

Adresses IP sortantes d’un travail d’applications conteneur.
properties.provisioningState

JobProvisioningState

État d’approvisionnement du travail Container Apps.
properties.template

JobTemplate

Définition du travail Container Apps.
properties.workloadProfileName

string

Nom du profil de charge de travail à épingler pour l’exécution du travail des applications conteneur.
systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

JobConfiguration

Propriétés de configuration du travail Container Apps sans version

Nom Type Valeur par défaut Description
eventTriggerConfig

EventTriggerConfig

Déclencher la configuration d’un travail piloté par les événements.
manualTriggerConfig

ManualTriggerConfig

Configuration manuelle du déclencheur pour un travail d’exécution unique. Les propriétés replicaCompletionCount et le parallélisme sont définis sur 1 par défaut
registries

RegistryCredentials[]

Collection d’informations d’identification du registre de conteneurs privé utilisées par un travail Container Apps
replicaRetryLimit

integer

Nombre maximal de nouvelles tentatives avant l’échec du travail.
replicaTimeout

integer

Nombre maximal de secondes qu’une réplica est autorisée à s’exécuter.
scheduleTriggerConfig

ScheduleTriggerConfig

Planification du déclencheur répétiteur au format Cron (« * * * * * ») pour cronjobs. Les complétions et le parallélisme des propriétés seraient définis sur 1 par défaut
secrets

Secret[]

Collection de secrets utilisés par un travail Container Apps
triggerType

TriggerType

Manual

Type de déclencheur du travail

JobProvisioningState

État d’approvisionnement du travail Container Apps.

Nom Type Description
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

JobScale

Mise à l’échelle des configurations pour les travaux pilotés par les événements.

Nom Type Valeur par défaut Description
maxExecutions

integer

100

Nombre maximal d’exécutions de travaux créées pour un déclencheur, 100 par défaut.
minExecutions

integer

0

Nombre minimal d’exécutions de travaux créées pour un déclencheur, valeur par défaut 0
pollingInterval

integer

Intervalle pour case activée chaque source d’événement en secondes. La valeur par défaut est 30s
rules

JobScaleRule[]

Règles de mise à l’échelle.

JobScaleRule

Règle de mise à l’échelle.

Nom Type Description
auth

ScaleRuleAuth[]

Secrets d’authentification pour la règle de mise à l’échelle.
metadata

object

Propriétés de métadonnées pour décrire la règle de mise à l’échelle.
name

string

Nom de la règle d’échelle
type

string

Type de la règle de mise à l’échelle, par exemple : azure-servicebus, redis, etc.

JobTemplate

Container Apps Définition d’application avec version de travail. Définit l’état souhaité d’une révision immuable. Toute modification apportée à cette section entraîne la création d’une nouvelle révision

Nom Type Description
containers

Container[]

Liste des définitions de conteneur pour l’application conteneur.
initContainers

InitContainer[]

Liste des conteneurs spécialisés qui s’exécutent avant les conteneurs d’application.
volumes

Volume[]

Liste des définitions de volume pour l’application conteneur.

ManagedServiceIdentity

Identité de service managée (identités affectées par le système et/ou par l’utilisateur)

Nom Type Description
principalId

string

ID de principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId

string

ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
userAssignedIdentities

<string,  UserAssignedIdentity>

identités User-Assigned
Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities sont des ID de ressource ARM au format : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

Nom Type Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManualTriggerConfig

Configuration manuelle du déclencheur pour un travail d’exécution unique. Les propriétés replicaCompletionCount et le parallélisme sont définis sur 1 par défaut

Nom Type Description
parallelism

integer

Nombre de réplicas parallèles d’un travail pouvant s’exécuter à un moment donné.
replicaCompletionCount

integer

Nombre minimal d’achèvements de réplica réussis avant l’achèvement global du travail.

RegistryCredentials

Registre privé de l’application conteneur

Nom Type Description
identity

string

Une identité managée à utiliser pour s’authentifier avec Azure Container Registry. Pour les identités affectées par l’utilisateur, utilisez l’ID de ressource complet de l’identité affectée par l’utilisateur. Pour les identités affectées par le système, utilisez « system »
passwordSecretRef

string

Nom du secret qui contient le mot de passe de connexion au registre
server

string

Container Registry Server
username

string

Nom d’utilisateur du registre de conteneurs

ScaleRuleAuth

Secrets d’authentification pour la règle d’échelle

Nom Type Description
secretRef

string

Nom du secret à partir duquel extraire les params d’authentification.
triggerParameter

string

Paramètre de déclencheur qui utilise le secret

ScheduleTriggerConfig

Planification du déclencheur répétiteur au format Cron (« * * * * * ») pour cronjobs. Les complétions et le parallélisme des propriétés seraient définis sur 1 par défaut

Nom Type Description
cronExpression

string

Planification répétée au format Cron (« * * * * * ») d’un travail Cron.
parallelism

integer

Nombre de réplicas parallèles d’un travail pouvant s’exécuter à un moment donné.
replicaCompletionCount

integer

Nombre minimal d’achèvements de réplica réussis avant l’achèvement global du travail.

Scheme

Schéma à utiliser pour la connexion à l’hôte. La valeur par défaut est HTTP.

Nom Type Description
HTTP

string

HTTPS

string

Secret

Définition de secret.

Nom Type Description
identity

string

ID de ressource d’une identité managée pour l’authentification auprès d’Azure Key Vault ou système pour utiliser une identité affectée par le système.
keyVaultUrl

string

Azure Key Vault URL pointant vers le secret référencé par l’application conteneur.
name

string

Nom du secret.
value

string

Valeur de secret.

SecretVolumeItem

Secret à ajouter au volume.

Nom Type Description
path

string

Chemin d’accès au secret du projet. Si aucun chemin n’est fourni, le chemin d’accès prend par défaut le nom du secret répertorié dans secretRef.
secretRef

string

Nom du secret d’application conteneur à partir duquel extraire la valeur du secret.

StorageType

Type de stockage pour le volume. Si ce n’est pas le cas, utilisez EmptyDir.

Nom Type Description
AzureFile

string

EmptyDir

string

Secret

string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

TcpSocket

TCPSocket spécifie une action impliquant un port TCP. Les hooks TCP ne sont pas encore pris en charge.

Nom Type Description
host

string

Facultatif : nom d’hôte auquel se connecter, valeur par défaut de l’adresse IP du pod.
port

integer

Numéro ou nom du port auquel accéder sur le conteneur. Le nombre doit être compris entre 1 et 65535. Le nom doit être un IANA_SVC_NAME.

TriggerType

Type de déclencheur du travail

Nom Type Description
Event

string

Manual

string

Schedule

string

Type

Type de sonde.

Nom Type Description
Liveness

string

Readiness

string

Startup

string

UserAssignedIdentity

Propriétés de l’identité affectée par l’utilisateur

Nom Type Description
clientId

string

ID client de l’identité affectée.
principalId

string

ID principal de l’identité affectée.

Volume

Définitions de volume pour l’application conteneur.

Nom Type Description
mountOptions

string

Options de montage utilisées lors du montage d’AzureFile. Doit être une chaîne séparée par des virgules.
name

string

Nom du volume.
secrets

SecretVolumeItem[]

Liste des secrets à ajouter dans le volume. Si aucun secret n’est fourni, tous les secrets de la collection sont ajoutés au volume.
storageName

string

Nom de la ressource de stockage. Il n’est pas nécessaire de fournir emptyDir et secret.
storageType

StorageType

Type de stockage pour le volume. Si ce n’est pas le cas, utilisez EmptyDir.

VolumeMount

Montage de volume pour l’application conteneur.

Nom Type Description
mountPath

string

Chemin d’accès dans le conteneur sur lequel le volume doit être monté. Ne doit pas contenir ' :'.
subPath

string

Chemin dans le volume à partir duquel le volume du conteneur doit être monté. La valeur par défaut est « » (racine du volume).
volumeName

string

Cela doit correspondre au nom d’un volume.