Condividi tramite


Jobs - Proxy Get

Ottenere le proprietà di un processo dell'app contenitore.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
apiName
path True

string

pattern: ^[-\w\._]+$

Nome API proxy per processo dell'app contenitore.

jobName
path True

string

pattern: ^[-\w\._\(\)]+$

Nome lavoro

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

minLength: 1

ID della sottoscrizione di destinazione.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

Job

Va bene

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 App Job by name

Esempio di richiesta

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

Risposta di esempio

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0/detectorproperties/rootApi",
  "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

Risposta di errore del servizio app.

Details

Dettagli o errore

EnvironmentVar

Variabile di ambiente contenitore dell'app 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.

IdentitySettings

Impostazioni facoltative per un'identità gestita assegnata all'app contenitore.

IdentitySettingsLifeCycle

Usare per selezionare le fasi del ciclo di vita di un'app contenitore durante la quale l'identità gestita deve essere disponibile.

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

Ridimensionamento 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 sia i tipi SystemAssigned che UserAssigned).

ManualTriggerConfig

Configurazione del trigger manuale per un singolo processo di esecuzione. Replica delle proprietàCompletionCount e parallelismo sono impostati 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 formattato Cron ("* * * * *") per cronjobs. I completamenti delle proprietà e il parallelismo vengono impostati su 1 per impostazione predefinita

Scheme

Schema da usare per la connessione all'host. Il valore predefinito è 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 (int32)

Errori consecutivi minimi per il probe da considerare 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 (int32)

Numero di secondi dopo l'avvio del contenitore prima dell'avvio dei probe di attività. Il valore minimo è 1. Il valore massimo è 60.

periodSeconds

integer (int32)

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

successThreshold

integer (int32)

Numero minimo di successi consecutivi che il probe deve essere considerato riuscito dopo aver avuto esito negativo.Minimum consecutive successful for the probe to be consider successful after having failed. 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 (int64)

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 tempo 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 (int32)

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 (double)

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.

Valore Descrizione
Application
Key
ManagedIdentity
User

DefaultErrorResponse

Risposta di errore del servizio app.

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.

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 (int32)

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

replicaCompletionCount

integer (int32)

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

scale

JobScale

Ridimensionamento 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 viene impostato l'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 (int32)

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 dell'intestazione

value

string

Valore del campo dell'intestazione

IdentitySettings

Impostazioni facoltative per un'identità gestita assegnata all'app contenitore.

Nome Tipo Valore predefinito Descrizione
identity

string

ID risorsa di un'identità gestita assegnata dall'utente assegnata dall'utente assegnata all'app contenitore o "system" per l'identità assegnata dal sistema.

lifecycle

IdentitySettingsLifeCycle

All

Usare per selezionare le fasi del ciclo di vita di un'app contenitore durante la quale l'identità gestita deve essere disponibile.

IdentitySettingsLifeCycle

Usare per selezionare le fasi del ciclo di vita di un'app contenitore durante la quale l'identità gestita deve essere disponibile.

Valore Descrizione
All
Init
Main
None

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 (arm-id)

ID 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 processo 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

Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.

tags

object

Tag di risorsa.

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.

identitySettings

IdentitySettings[]

Impostazioni facoltative per le identità gestite assegnate al processo dell'app contenitore. Se non viene specificata un'identità gestita, verranno usate le impostazioni predefinite.

manualTriggerConfig

ManualTriggerConfig

Configurazione del trigger manuale per un singolo processo di esecuzione. Replica delle proprietàCompletionCount e parallelismo sono impostati su 1 per impostazione predefinita

registries

RegistryCredentials[]

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

replicaRetryLimit

integer (int32)

Numero massimo di tentativi prima di non riuscire il processo.

replicaTimeout

integer (int32)

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

scheduleTriggerConfig

ScheduleTriggerConfig

Pianificazione del trigger ripetuto formattato Cron ("* * * * *") per cronjobs. I completamenti delle proprietà e il parallelismo vengono impostati su 1 per impostazione predefinita

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.

Valore Descrizione
Canceled
Deleting
Failed
InProgress
Succeeded

JobScale

Ridimensionamento delle configurazioni per i processi basati su eventi.

Nome Tipo Valore predefinito Descrizione
maxExecutions

integer (int32)

100

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

minExecutions

integer (int32)

0

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

pollingInterval

integer (int32)

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à.

identity

string

ID risorsa di un'identità gestita assegnata dall'utente assegnata dall'utente assegnata all'app contenitore o "system" per l'identità assegnata dal sistema.

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 contenitori per l'app contenitore.

initContainers

InitContainer[]

Elenco di contenitori specializzati eseguiti prima dei contenitori dell'app.

volumes

Volume[]

Elenco delle 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 (uuid)

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

tenantId

string (uuid)

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 sia i tipi SystemAssigned che 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 sia i tipi SystemAssigned che UserAssigned).

Valore Descrizione
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

ManualTriggerConfig

Configurazione del trigger manuale per un singolo processo di esecuzione. Replica delle proprietàCompletionCount e parallelismo sono impostati su 1 per impostazione predefinita

Nome Tipo Descrizione
parallelism

integer (int32)

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

replicaCompletionCount

integer (int32)

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 parametri di autenticazione.

triggerParameter

string

Parametro trigger che usa il segreto

ScheduleTriggerConfig

Pianificazione del trigger ripetuto formattato Cron ("* * * * *") per cronjobs. I completamenti delle proprietà e il parallelismo vengono impostati su 1 per impostazione predefinita

Nome Tipo Descrizione
cronExpression

string

Pianificazione ripetuta formattata Cron ("* * * * *") di un processo Cron.

parallelism

integer (int32)

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

replicaCompletionCount

integer (int32)

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

Scheme

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

Valore Descrizione
HTTP
HTTPS

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, il percorso predefinito è il 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.

Valore Descrizione
AzureFile
EmptyDir
NfsAzureFile
Secret

systemData

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

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string (date-time)

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 viene impostato l'indirizzo IP del pod.

port

integer (int32)

Numero o nome 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.

TriggerType

Tipo di trigger del processo

Valore Descrizione
Event
Manual
Schedule

Type

Tipo di probe.

Valore Descrizione
Liveness
Readiness
Startup

UserAssignedIdentity

Proprietà di identità assegnate dall'utente

Nome Tipo Descrizione
clientId

string (uuid)

ID client dell'identità assegnata.

principalId

string (uuid)

ID entità dell'identità assegnata.

Volume

Definizioni di volume per l'app contenitore.

Nome Tipo Descrizione
mountOptions

string

Opzioni di montaggio usate durante il montaggio della condivisione file di Azure o della condivisione file di Azure NFS. 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.