Condividi tramite

Jobs - Get

  • Riferimento
Servizio:
Azure Container Apps
Versione API:
2024-03-01

Ottenere le proprietà di un processo di app contenitore.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
jobName
 path True

string

Nome processo

Criterio di espressione regolare: ^[-\w\._\(\)]+$
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

Job

OK.
Other Status Codes

DefaultErrorResponse

Risposta di errore comune.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get Container Apps Job

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
          }
        }
      ]
    }
  }
}

Definizioni

Nome Descrizione
Container

Definizione del contenitore dell'app contenitore
ContainerAppProbe

Il probe descrive un controllo di integrità da eseguire su un contenitore per determinare se è attivo o pronto per ricevere il traffico.
ContainerResources

Requisiti delle risorse contenitore dell'app contenitore contenitore.
createdByType

Tipo di identità che ha creato la risorsa.
DefaultErrorResponse

servizio app risposta di errore.
Details

Dettagli o errore
EnvironmentVar

Variabile di ambiente contenitore dell'app contenitore contenitore contenitore.
Error

Modello di errore.
EventTriggerConfig

Attivare la configurazione di un processo basato su eventi.
HttpGet

HTTPGet specifica la richiesta HTTP da eseguire.
HttpHeaders

Intestazioni personalizzate da impostare nella richiesta. HTTP consente intestazioni ripetute.
InitContainer

Definizione del contenitore init dell'app contenitore
Job

Processo dell'app contenitore
JobConfiguration

Proprietà di configurazione del processo di app contenitore non con controllo delle versioni
JobProvisioningState

Stato di provisioning del processo app contenitore.
JobScale

Scalabilità delle configurazioni per i processi basati su eventi.
JobScaleRule

Regola di ridimensionamento.
JobTemplate

Definizione dell'applicazione con controllo delle versioni del processo di App contenitore. Definisce lo stato desiderato di una revisione non modificabile. Eventuali modifiche apportate a questa sezione comporterà la creazione di una nuova revisione
ManagedServiceIdentity

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)
ManagedServiceIdentityType

Tipo di identità del servizio gestito (in cui sono consentiti i tipi SystemAssigned e UserAssigned).
ManualTriggerConfig

Configurazione del trigger manuale per un singolo processo di esecuzione. Le proprietà replicaCompletionCount e parallelismo vengono impostate su 1 per impostazione predefinita
RegistryCredentials

Registro privato dell'app contenitore
ScaleRuleAuth

Segreti di autenticazione per la regola di scalabilità
ScheduleTriggerConfig

Pianificazione del trigger ripetuto formattata Cron ("* * * * *") per cronjobs. Per impostazione predefinita, i completamenti e il parallelismo delle proprietà verranno impostati su 1
Scheme

Schema da usare per la connessione all'host. Impostazione predefinita su HTTP.
Secret

Definizione del segreto.
SecretVolumeItem

Segreto da aggiungere al volume.
StorageType

Tipo di archiviazione per il volume. Se non specificato, usare EmptyDir.
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.
TcpSocket

TCPSocket specifica un'azione che coinvolge una porta TCP. Hook TCP non ancora supportati.
TriggerType

Tipo di trigger del processo
Type

Tipo di probe.
UserAssignedIdentity

Proprietà di identità assegnate dall'utente
Volume

Definizioni di volume per l'app contenitore.
VolumeMount

Montaggio del volume per l'app contenitore.

Container

Definizione del contenitore dell'app contenitore

Nome Tipo Descrizione
args

string[]

Argomenti del comando di avvio del contenitore.
command

string[]

Comando start del contenitore.
env

EnvironmentVar[]

Variabili di ambiente del contenitore.
image

string

Tag immagine contenitore.
name

string

Nome del contenitore personalizzato.
probes

ContainerAppProbe[]

Elenco di probe per il contenitore.
resources

ContainerResources

Requisiti delle risorse del contenitore.
volumeMounts

VolumeMount[]

Montaggi del volume del contenitore.

ContainerAppProbe

Il probe descrive un controllo di integrità da eseguire su un contenitore per determinare se è attivo o pronto per ricevere il traffico.

Nome Tipo Descrizione
failureThreshold

integer

Errori consecutivi minimi che il probe deve essere considerato non riuscito dopo l'esito positivo. Il valore predefinito è 3. Il valore minimo è 1. Il valore massimo è 10.
httpGet

HttpGet

HTTPGet specifica la richiesta HTTP da eseguire.
initialDelaySeconds

integer

Il numero di secondi dopo l'avvio del contenitore prima che vengano avviati i probe di attività. Il valore minimo è 1. Il valore massimo è 60.
periodSeconds

integer

Frequenza (in secondi) per eseguire il probe. Il valore predefinito è 10 secondi. Il valore minimo è 1. Il valore massimo è 240.
successThreshold

integer

Numero minimo di successi consecutivi per il probe da considerare riuscito dopo l'esito negativo. Assume il valore predefinito 1. Deve essere 1 per la vita e l'avvio. Il valore minimo è 1. Il valore massimo è 10.
tcpSocket

TcpSocket

TCPSocket specifica un'azione che coinvolge una porta TCP. Hook TCP non ancora supportati.
terminationGracePeriodSeconds

integer

La durata facoltativa in secondi del pod deve terminare normalmente in caso di errore del probe. Il periodo di tolleranza è la durata in secondi dopo che i processi in esecuzione nel pod vengono inviati un segnale di terminazione e il momento in cui i processi vengono interrotti forzatamente con un segnale di terminazione. Impostare questo valore più lungo del tempo di pulizia previsto per il processo. Se questo valore è nil, verrà usata la terminazione del podGracePeriodSeconds. In caso contrario, questo valore esegue l'override del valore fornito dalla specifica del pod. Il valore deve essere un numero intero non negativo. Il valore zero indica l'arresto immediato tramite il segnale kill (nessuna opportunità di arresto). Si tratta di un campo alfa e richiede l'abilitazione del controllo delle funzionalità ProbeTerminationGracePeriod. Il valore massimo è 3600 secondi (1 ora)
timeoutSeconds

integer

Numero di secondi dopo il quale si verifica il timeout del probe. Il valore predefinito è 1 secondo. Il valore minimo è 1. Il valore massimo è 240.
type

Type

Tipo di probe.

ContainerResources

Requisiti delle risorse contenitore dell'app contenitore contenitore.

Nome Tipo Descrizione
cpu

number

CPU necessaria nei core, ad esempio 0,5
ephemeralStorage

string

Archiviazione temporanea, ad esempio "1Gi"
memory

string

Memoria necessaria, ad esempio "250 Mb"

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultErrorResponse

servizio app risposta di errore.

Nome Tipo Descrizione
error

Error

Modello di errore.

Details

Dettagli o errore

Nome Tipo Descrizione
code

string

Stringa standardizzata per identificare l'errore a livello di codice.
message

string

Descrizione dettagliata dell'errore e informazioni di debug.
target

string

Descrizione dettagliata dell'errore e informazioni di debug.

EnvironmentVar

Variabile di ambiente contenitore dell'app contenitore contenitore contenitore.

Nome Tipo Descrizione
name

string

Nome della variabile di ambiente.
secretRef

string

Nome del segreto dell'app contenitore da cui eseguire il pull del valore della variabile di ambiente.
value

string

Valore della variabile di ambiente non segreto.

Error

Modello di errore.

Nome Tipo Descrizione
code

string

Stringa standardizzata per identificare l'errore a livello di codice.
details

Details[]

Dettagli o errore
innererror

string

Altre informazioni per eseguire il debug dell'errore.
message

string

Descrizione dettagliata dell'errore e informazioni di debug.
target

string

Descrizione dettagliata dell'errore e informazioni di debug.

EventTriggerConfig

Attivare la configurazione di un processo basato su eventi.

Nome Tipo Descrizione
parallelism

integer

Numero di repliche parallele di un processo che può essere eseguito in un determinato momento.
replicaCompletionCount

integer

Numero minimo di completamenti delle repliche riuscite prima del completamento complessivo del processo.
scale

JobScale

Scalabilità delle configurazioni per i processi basati su eventi.

HttpGet

HTTPGet specifica la richiesta HTTP da eseguire.

Nome Tipo Descrizione
host

string

Nome host a cui connettersi per impostazione predefinita all'INDIRIZZO IP del pod. È probabile che si voglia impostare "Host" in httpHeaders.
httpHeaders

HttpHeaders[]

Intestazioni personalizzate da impostare nella richiesta. HTTP consente intestazioni ripetute.
path

string

Percorso di accesso nel server HTTP.
port

integer

Nome o numero della porta a cui accedere nel contenitore. Il numero deve essere compreso nell'intervallo compreso tra 1 e 65535. Il nome deve essere un IANA_SVC_NAME.
scheme

Scheme

Schema da usare per la connessione all'host. Il valore predefinito è HTTP.

HttpHeaders

Intestazioni personalizzate da impostare nella richiesta. HTTP consente intestazioni ripetute.

Nome Tipo Descrizione
name

string

Nome del campo di intestazione
value

string

Valore del campo intestazione

InitContainer

Definizione del contenitore init dell'app contenitore

Nome Tipo Descrizione
args

string[]

Argomenti del comando di avvio del contenitore.
command

string[]

Comando start del contenitore.
env

EnvironmentVar[]

Variabili di ambiente del contenitore.
image

string

Tag immagine contenitore.
name

string

Nome del contenitore personalizzato.
resources

ContainerResources

Requisiti delle risorse del contenitore.
volumeMounts

VolumeMount[]

Montaggi del volume del contenitore.

Job

Processo dell'app contenitore

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

ManagedServiceIdentity

Identità gestite necessarie da un processo dell'app contenitore per interagire con altri servizi di Azure per non gestire segreti o credenziali nel codice.
location

string

Posizione geografica in cui risiede la risorsa
name

string

nome della risorsa.
properties.configuration

JobConfiguration

Proprietà di configurazione del processo di App contenitore.
properties.environmentId

string

ID risorsa dell'ambiente.
properties.eventStreamEndpoint

string

Endpoint del flusso di eventi del processo delle app contenitore.
properties.outboundIpAddresses

string[]

Indirizzi IP in uscita di un processo di app contenitore.
properties.provisioningState

JobProvisioningState

Stato di provisioning del processo app contenitore.
properties.template

JobTemplate

Definizione del processo app contenitore.
properties.workloadProfileName

string

Nome del profilo del carico di lavoro da aggiungere per l'esecuzione del processo delle app contenitore.
systemData

systemData

Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
tags

object

Tag delle risorse.
type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

JobConfiguration

Proprietà di configurazione del processo di app contenitore non con controllo delle versioni

Nome Tipo Valore predefinito Descrizione
eventTriggerConfig

EventTriggerConfig

Attivare la configurazione di un processo basato su eventi.
manualTriggerConfig

ManualTriggerConfig

Configurazione del trigger manuale per un singolo processo di esecuzione. Le proprietà replicaCompletionCount e parallelismo vengono impostate su 1 per impostazione predefinita
registries

RegistryCredentials[]

Raccolta di credenziali del registro contenitori privato usate da un processo di app Contenitore
replicaRetryLimit

integer

Numero massimo di tentativi prima dell'esito negativo del processo.
replicaTimeout

integer

Numero massimo di secondi consentiti per l'esecuzione di una replica.
scheduleTriggerConfig

ScheduleTriggerConfig

Pianificazione del trigger ripetuto formattata Cron ("* * * * *") per cronjobs. Per impostazione predefinita, i completamenti e il parallelismo delle proprietà verranno impostati su 1
secrets

Secret[]

Raccolta di segreti usati da un processo di app contenitore
triggerType

TriggerType

Manual

Tipo di trigger del processo

JobProvisioningState

Stato di provisioning del processo app contenitore.

Nome Tipo Descrizione
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

JobScale

Scalabilità delle configurazioni per i processi basati su eventi.

Nome Tipo Valore predefinito Descrizione
maxExecutions

integer

100

Numero massimo di esecuzioni di processi create per un trigger, valore predefinito 100.
minExecutions

integer

0

Numero minimo di esecuzioni di processi create per un trigger, valore predefinito 0
pollingInterval

integer

Intervallo per controllare ogni origine evento in secondi. Il valore predefinito è 30s
rules

JobScaleRule[]

Regole di ridimensionamento.

JobScaleRule

Regola di ridimensionamento.

Nome Tipo Descrizione
auth

ScaleRuleAuth[]

Segreti di autenticazione per la regola di scalabilità.
metadata

object

Proprietà dei metadati per descrivere la regola di scalabilità.
name

string

Nome regola di scalabilità
type

string

Tipo di regola di scalabilità, ad esempio azure-servicebus, redis e così via.

JobTemplate

Definizione dell'applicazione con controllo delle versioni del processo di App contenitore. Definisce lo stato desiderato di una revisione non modificabile. Eventuali modifiche apportate a questa sezione comporterà la creazione di una nuova revisione

Nome Tipo Descrizione
containers

Container[]

Elenco di definizioni di contenitore per l'app contenitore.
initContainers

InitContainer[]

Elenco di contenitori specializzati eseguiti prima dei contenitori di app.
volumes

Volume[]

Elenco di definizioni di volume per l'app contenitore.

ManagedServiceIdentity

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)

Nome Tipo Descrizione
principalId

string

ID dell'entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
tenantId

string

ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
type

ManagedServiceIdentityType

Tipo di identità del servizio gestito (in cui sono consentiti i tipi SystemAssigned e UserAssigned).
userAssignedIdentities

<string,  UserAssignedIdentity>

identità User-Assigned
Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste.

ManagedServiceIdentityType

Tipo di identità del servizio gestito (in cui sono consentiti i tipi SystemAssigned e UserAssigned).

Nome Tipo Descrizione
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManualTriggerConfig

Configurazione del trigger manuale per un singolo processo di esecuzione. Le proprietà replicaCompletionCount e parallelismo vengono impostate su 1 per impostazione predefinita

Nome Tipo Descrizione
parallelism

integer

Numero di repliche parallele di un processo che può essere eseguito in un determinato momento.
replicaCompletionCount

integer

Numero minimo di completamenti delle repliche riuscite prima del completamento complessivo del processo.

RegistryCredentials

Registro privato dell'app contenitore

Nome Tipo Descrizione
identity

string

Identità gestita da usare per l'autenticazione con Registro Azure Container. Per le identità assegnate dall'utente, usare l'ID risorsa di identità assegnato dall'utente completo. Per le identità assegnate dal sistema, usare "system"
passwordSecretRef

string

Nome del segreto che contiene la password di accesso del Registro di sistema
server

string

Server registro contenitori
username

string

Nome utente registro contenitori

ScaleRuleAuth

Segreti di autenticazione per la regola di scalabilità

Nome Tipo Descrizione
secretRef

string

Nome del segreto da cui eseguire il pull dei params di autenticazione.
triggerParameter

string

Parametro trigger che usa il segreto

ScheduleTriggerConfig

Pianificazione del trigger ripetuto formattata Cron ("* * * * *") per cronjobs. Per impostazione predefinita, i completamenti e il parallelismo delle proprietà verranno impostati su 1

Nome Tipo Descrizione
cronExpression

string

Pianificazione ripetuta in formato Cron ("* * * * *") di un processo Cron.
parallelism

integer

Numero di repliche parallele di un processo che può essere eseguito in un determinato momento.
replicaCompletionCount

integer

Numero minimo di completamenti delle repliche riuscite prima del completamento complessivo del processo.

Scheme

Schema da usare per la connessione all'host. Impostazione predefinita su HTTP.

Nome Tipo Descrizione
HTTP

string

HTTPS

string

Secret

Definizione del segreto.

Nome Tipo Descrizione
identity

string

ID risorsa di un'identità gestita per l'autenticazione con Azure Key Vault o Sistema per l'uso di un'identità assegnata dal sistema.
keyVaultUrl

string

URL di Azure Key Vault che punta al segreto a cui fa riferimento l'app contenitore.
name

string

Nome segreto.
value

string

Valore segreto.

SecretVolumeItem

Segreto da aggiungere al volume.

Nome Tipo Descrizione
path

string

Percorso del segreto del progetto. Se non viene specificato alcun percorso, per impostazione predefinita il percorso viene assegnato al nome del segreto elencato in secretRef.
secretRef

string

Nome del segreto dell'app contenitore da cui eseguire il pull del valore del segreto.

StorageType

Tipo di archiviazione per il volume. Se non specificato, usare EmptyDir.

Nome Tipo Descrizione
AzureFile

string

EmptyDir

string

Secret

string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

TcpSocket

TCPSocket specifica un'azione che coinvolge una porta TCP. Hook TCP non ancora supportati.

Nome Tipo Descrizione
host

string

Facoltativo: nome host a cui connettersi per impostazione predefinita all'INDIRIZZO IP del pod.
port

integer

Numero o nome della porta a cui accedere nel contenitore. Il numero deve essere compreso nell'intervallo da 1 a 65535. Il nome deve essere un IANA_SVC_NAME.

TriggerType

Tipo di trigger del processo

Nome Tipo Descrizione
Event

string

Manual

string

Schedule

string

Type

Tipo di probe.

Nome Tipo Descrizione
Liveness

string

Readiness

string

Startup

string

UserAssignedIdentity

Proprietà di identità assegnate dall'utente

Nome Tipo Descrizione
clientId

string

ID client dell'identità assegnata.
principalId

string

ID principale dell'identità assegnata.

Volume

Definizioni di volume per l'app contenitore.

Nome Tipo Descrizione
mountOptions

string

Opzioni di montaggio usate durante il montaggio di AzureFile. Deve essere una stringa delimitata da virgole.
name

string

Nome del volume.
secrets

SecretVolumeItem[]

Elenco dei segreti da aggiungere nel volume. Se non vengono forniti segreti, tutti i segreti nella raccolta verranno aggiunti al volume.
storageName

string

Nome della risorsa di archiviazione. Non è necessario specificare EmptyDir e Secret.
storageType

StorageType

Tipo di archiviazione per il volume. Se non specificato, usare EmptyDir.

VolumeMount

Montaggio del volume per l'app contenitore.

Nome Tipo Descrizione
mountPath

string

Percorso all'interno del contenitore in cui deve essere montato il volume. Non deve contenere ':'.
subPath

string

Percorso all'interno del volume da cui deve essere montato il volume del contenitore. Il valore predefinito è "" (radice del volume).
volumeName

string

Deve corrispondere al nome di un volume.