Jobs - List

Servizio:: Azure Spring Apps

Versione API:: 2024-05-01-preview

Ottenere i processi di Azure Spring Apps in un determinato servizio

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/jobs?api-version=2024-05-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Nome della risorsa del servizio.
subscriptionId	path	True	string	Ottiene l'ID sottoscrizione che identifica in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	JobResourceCollection	Successo. La risposta descrive l'elenco dei processi nel servizio.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

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

Jobs_List

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/jobs?api-version=2024-05-01-preview

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "triggerConfig": {
          "triggerType": "Manual"
        },
        "source": {
          "type": "BuildResult",
          "buildResultId": "<default>"
        },
        "template": {
          "environmentVariables": [
            {
              "name": "key1",
              "value": "value1"
            },
            {
              "name": "env2",
              "value": "value2"
            },
            {
              "name": "secretKey1"
            }
          ],
          "args": [
            "arg1",
            "arg2"
          ]
        }
      },
      "systemData": {
        "createdBy": "sample-user",
        "createdByType": "User",
        "createdAt": "2021-08-11T03:16:03.944Z",
        "lastModifiedBy": "sample-user",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-11T03:17:03.944Z"
      },
      "type": "Microsoft.AppPlatform/Spring/jobs",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/jobs/test-job",
      "name": "test-job"
    }
  ]
}

Definizioni

Nome	Descrizione
BuildResultUserSourceInfo	Riferimento a un risultato di compilazione
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
createdByType	Tipo di identità che ha creato la risorsa.
CustomContainer	Payload del contenitore personalizzato
CustomContainerUserSourceInfo	Informazioni sull'origine utente del contenitore personalizzato
EnvVar	Variabile di ambiente dei componenti di Azure Spring Apps.
ImageRegistryCredential	Credenziali del Registro di sistema delle immagini
JobExecutionTemplate	Modello di esecuzione del processo, contenente la configurazione per un'esecuzione
JobResource	Payload della risorsa processo
JobResourceCollection	Elenco dei processi di Azure Spring Apps e un possibile collegamento per il set successivo.
JobResourceProperties	Payload delle proprietà delle risorse processo
JobResourceProvisioningState	Stato di provisioning del processo
JobResourceRequests	Payload della richiesta di risorsa processo
lastModifiedByType	Tipo di identità che ha modificato l'ultima volta la risorsa.
ManagedComponentReference	Un riferimento al componente gestito come Config Server.
ManualJobTriggerConfig	Configurazione per il processo attivato manualmente
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

BuildResultUserSourceInfo

Object

Riferimento a un risultato di compilazione

Nome	Tipo	Descrizione
buildResultId	string	ID risorsa di un risultato di compilazione esistente completato nella stessa istanza spring.
type	string: BuildResult	Tipo dell'origine caricata
version	string	Versione dell'origine

CloudError

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore dal servizio.

CloudErrorBody

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

CustomContainer

Object

Payload del contenitore personalizzato

Nome	Tipo	Descrizione
args	string[]	Argomenti per il punto di ingresso. Il CMD dell'immagine Docker viene usato se non viene specificato.
command	string[]	Matrice di punti di ingresso. Non eseguito all'interno di una shell. Se non viene specificato, viene usato ENTRYPOINT dell'immagine Docker.
containerImage	string	Immagine del contenitore personalizzato. Deve essere sotto forma di <repository>:<tag> senza il nome del server del Registro di sistema
imageRegistryCredential	ImageRegistryCredential	Credenziali del Registro di sistema delle immagini
languageFramework	string	Framework del linguaggio dell'immagine del contenitore caricata. Valori supportati: "springboot", "", null.
server	string	Nome del Registro di sistema che contiene l'immagine del contenitore

CustomContainerUserSourceInfo

Object

Informazioni sull'origine utente del contenitore personalizzato

Nome	Tipo	Descrizione
customContainer	CustomContainer	Payload del contenitore personalizzato
type	string: Container	Tipo dell'origine caricata
version	string	Versione dell'origine

EnvVar

Object

Variabile di ambiente dei componenti di Azure Spring Apps.

Nome	Tipo	Descrizione
name	string	Nome della variabile di ambiente.
secretValue	string	valore della variabile di ambiente secret.
value	string	Valore della variabile di ambiente non segreto.

ImageRegistryCredential

Object

Credenziali del Registro di sistema delle immagini

Nome	Tipo	Descrizione
password	string	Password delle credenziali del Registro di sistema delle immagini
username	string	Nome utente della credenziale del Registro di sistema delle immagini

JobExecutionTemplate

Object

Modello di esecuzione del processo, contenente la configurazione per un'esecuzione

Nome	Tipo	Descrizione
args	string[]	Argomenti per l'esecuzione del processo.
environmentVariables	EnvVar[]	Variabili di ambiente dell'esecuzione del processo
resourceRequests	JobResourceRequests	Quantità di risorse richiesta per la CPU e la memoria necessarie.

JobResource

Object

Payload della risorsa processo

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa.
name	string	Nome della risorsa.
properties	JobResourceProperties	Proprietà della risorsa processo
systemData	SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo di risorsa.

JobResourceCollection

Object

Elenco dei processi di Azure Spring Apps e un possibile collegamento per il set successivo.

Nome	Tipo	Descrizione
nextLink	string	Collegarsi alla pagina successiva delle risorse.
value	JobResource[]	Raccolta di risorse per i processi.

JobResourceProperties

Object

Payload delle proprietà delle risorse processo

Nome	Tipo	Descrizione
managedComponentReferences	ManagedComponentReference[]	Raccolta di componenti gestiti a cui si fa riferimento
provisioningState	JobResourceProvisioningState	Stato di provisioning del processo
source	UserSourceInfo: BuildResultUserSourceInfo CustomContainerUserSourceInfo	Informazioni sull'origine caricate del processo.
template	JobExecutionTemplate	Modello applicato per tutte le esecuzioni del processo.
triggerConfig	JobTriggerConfig: ManualJobTriggerConfig	Configurazione correlata al trigger di processo.

JobResourceProvisioningState

Enumerazione

Stato di provisioning del processo

Valore	Descrizione
Succeeded
Failed
Creating
Updating
Deleting
Canceled

JobResourceRequests

Object

Payload della richiesta di risorsa processo

Nome	Tipo	Valore predefinito	Descrizione
cpu	string	1	CPU allocata a ogni istanza di esecuzione del processo.
memory	string	2Gi	Memoria allocata a ogni istanza di esecuzione del processo.

lastModifiedByType

Enumerazione

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

Valore	Descrizione
User
Application
ManagedIdentity
Key

ManagedComponentReference

Object

Un riferimento al componente gestito come Config Server.

Nome	Tipo	Descrizione
resourceId	string (arm-id)	ID risorsa del componente gestito

ManualJobTriggerConfig

Object

Configurazione per il processo attivato manualmente

Nome	Tipo	Valore predefinito	Descrizione
parallelism	integer (int32)		Numero di repliche parallele di un'esecuzione del processo.
retryLimit	integer (int32)		Numero massimo di tentativi prima di non riuscire il processo.
timeoutInSeconds	integer (int32)		Numero massimo di secondi consentiti per l'esecuzione di un'esecuzione.
triggerType	string: Manual	Manual	Tipo di trigger di processo

SystemData

Object

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 della modifica della risorsa (UTC).
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	lastModifiedByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Jobs - List

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Jobs_List

Esempio di richiesta

Risposta di esempio

Definizioni

BuildResultUserSourceInfo

CloudError

CloudErrorBody

createdByType

CustomContainer

CustomContainerUserSourceInfo

EnvVar

ImageRegistryCredential

JobExecutionTemplate

JobResource

JobResourceCollection

JobResourceProperties

JobResourceProvisioningState

JobResourceRequests

lastModifiedByType

ManagedComponentReference

ManualJobTriggerConfig

SystemData