Udostępnij za pośrednictwem

Jobs - Get

  • Odwołanie
Usługa:
Azure Container Apps
Wersja interfejsu API:
2024-03-01

Pobierz właściwości zadania usługi Container Apps.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
jobName
 path True

string

Nazwa zadania

Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+$
resourceGroupName
 path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId
 path True

string

Identyfikator subskrypcji docelowej.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Job

OK.
Other Status Codes

DefaultErrorResponse

Typowa odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Get Container Apps Job

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
          }
        }
      ]
    }
  }
}

Definicje

Nazwa Opis
Container

Definicja kontenera aplikacji kontenera
ContainerAppProbe

Sonda opisuje kontrolę kondycji do wykonania względem kontenera w celu określenia, czy jest on aktywny, czy gotowy do odbierania ruchu.
ContainerResources

Wymagania dotyczące zasobów kontenera aplikacji kontenera.
createdByType

Typ tożsamości, która utworzyła zasób.
DefaultErrorResponse

App Service odpowiedź na błąd.
Details

Szczegóły lub błąd
EnvironmentVar

Zmienna środowiskowa kontenera aplikacji kontenera.
Error

Model błędu.
EventTriggerConfig

Wyzwalanie konfiguracji zadania sterowanego zdarzeniami.
HttpGet

Element HTTPGet określa żądanie HTTP do wykonania.
HttpHeaders

Nagłówki niestandardowe do ustawienia w żądaniu. Protokół HTTP zezwala na powtarzające się nagłówki.
InitContainer

Definicja kontenera init aplikacji kontenera
Job

Zadanie aplikacji kontenera
JobConfiguration

Nieoparte na wersji właściwości konfiguracji zadania usługi Container Apps
JobProvisioningState

Stan aprowizacji zadania usługi Container Apps.
JobScale

Skalowanie konfiguracji dla zadań sterowanych zdarzeniami.
JobScaleRule

Reguła skalowania.
JobTemplate

Definicja aplikacji z wersją zadania usługi Container Apps. Definiuje żądany stan niezmiennej poprawki. Wszelkie zmiany w tej sekcji spowodują utworzenie nowej poprawki
ManagedServiceIdentity

Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub przypisane przez użytkownika)
ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
ManualTriggerConfig

Konfiguracja wyzwalacza ręcznego dla pojedynczego zadania wykonywania. Właściwości replicaCompletionCount i parallelism zostaną domyślnie ustawione na 1
RegistryCredentials

Rejestr prywatny aplikacji kontenera
ScaleRuleAuth

Auth Secrets for Scale Rule
ScheduleTriggerConfig

Harmonogram powtarzanych wyzwalaczy Cron ("* * * * *") dla cronjobs. Uzupełnianie właściwości i równoległość są domyślnie ustawione na 1
Scheme

Schemat używany do nawiązywania połączenia z hostem. Wartość domyślna to HTTP.
Secret

Definicja wpisu tajnego.
SecretVolumeItem

Wpis tajny do dodania do woluminu.
StorageType

Typ magazynu dla woluminu. Jeśli nie zostanie podana, użyj wartości EmptyDir.
systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TcpSocket

TcpSocket określa akcję obejmującą port TCP. Punkty zaczepienia TCP nie są jeszcze obsługiwane.
TriggerType

Typ wyzwalacza zadania
Type

Typ sondy.
UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika
Volume

Definicje woluminów dla aplikacji kontenera.
VolumeMount

Instalacja woluminu dla aplikacji kontenera.

Container

Definicja kontenera aplikacji kontenera

Nazwa Typ Opis
args

string[]

Argumenty polecenia uruchamiania kontenera.
command

string[]

Polecenie uruchamiania kontenera.
env

EnvironmentVar[]

Zmienne środowiskowe kontenera.
image

string

Tag obrazu kontenera.
name

string

Niestandardowa nazwa kontenera.
probes

ContainerAppProbe[]

Lista sond dla kontenera.
resources

ContainerResources

Wymagania dotyczące zasobów kontenera.
volumeMounts

VolumeMount[]

Instalacja woluminu kontenera.

ContainerAppProbe

Sonda opisuje kontrolę kondycji do wykonania względem kontenera w celu określenia, czy jest on aktywny, czy gotowy do odbierania ruchu.

Nazwa Typ Opis
failureThreshold

integer

Minimalna liczba kolejnych niepowodzeń dla sondy, które mają zostać uznane za zakończone niepowodzeniem po pomyślnym zakończeniu. Wartość domyślna to 3. Wartość minimalna to 1. Wartość maksymalna to 10.
httpGet

HttpGet

Element HTTPGet określa żądanie HTTP do wykonania.
initialDelaySeconds

integer

Liczba sekund po uruchomieniu kontenera przed zainicjowaniem sond żywotności. Wartość minimalna to 1. Wartość maksymalna to 60.
periodSeconds

integer

Jak często (w sekundach) wykonać sondę. Wartość domyślna to 10 sekund. Wartość minimalna to 1. Wartość maksymalna to 240.
successThreshold

integer

Minimalna liczba kolejnych sukcesów dla sondy, która ma zostać uznana za pomyślną po niepodaniu. Wartość domyślna to 1. Musi być 1 dla życia i uruchamiania. Wartość minimalna to 1. Wartość maksymalna to 10.
tcpSocket

TcpSocket

TcpSocket określa akcję obejmującą port TCP. Punkty zaczepienia TCP nie są jeszcze obsługiwane.
terminationGracePeriodSeconds

integer

Opcjonalny czas trwania w sekundach zasobnik musi zostać bezpiecznie zakończony po awarii sondy. Okres prolongaty to czas trwania w sekundach po wysłaniu sygnału zakończenia procesów uruchomionych w zasobniku oraz czasu wymuszonego zatrzymania procesów za pomocą sygnału zabicia. Ustaw tę wartość dłużej niż oczekiwany czas oczyszczania dla procesu. Jeśli ta wartość jest zerowa, zostanie użyte zakończenie zasobnikaGracePeriodSeconds. W przeciwnym razie ta wartość zastępuje wartość podaną przez specyfikację zasobnika. Wartość musi być nieujemną liczbą całkowitą. Wartość zero wskazuje zatrzymać się natychmiast za pośrednictwem sygnału zabicia (brak możliwości zamknięcia). Jest to pole alfa i wymaga włączenia bramki funkcji ProbeTerminationGracePeriod. Wartość maksymalna to 3600 sekund (1 godzina)
timeoutSeconds

integer

Liczba sekund, po których upłynął limit czasu sondy. Wartość domyślna to 1 sekunda. Wartość minimalna to 1. Wartość maksymalna to 240.
type

Type

Typ sondy.

ContainerResources

Wymagania dotyczące zasobów kontenera aplikacji kontenera.

Nazwa Typ Opis
cpu

number

Wymagany procesor CPU w rdzeniach, np. 0,5
ephemeralStorage

string

Efemeryczny magazyn, np. "1Gi"
memory

string

Wymagana pamięć, np. "250 Mb"

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa Typ Opis
error

Error

Model błędu.

Details

Szczegóły lub błąd

Nazwa Typ Opis
code

string

Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message

string

Szczegółowy opis błędu i informacje o debugowaniu.
target

string

Szczegółowy opis błędu i informacje o debugowaniu.

EnvironmentVar

Zmienna środowiskowa kontenera aplikacji kontenera.

Nazwa Typ Opis
name

string

Nazwa zmiennej środowiskowej.
secretRef

string

Nazwa wpisu tajnego aplikacji kontenera, z którego ma być ściągana wartość zmiennej środowiskowej.
value

string

Wartość zmiennej środowiskowej bez wpisu tajnego.

Error

Model błędu.

Nazwa Typ Opis
code

string

Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details

Details[]

Szczegóły lub błąd
innererror

string

Więcej informacji na temat debugowania błędu.
message

string

Szczegółowy opis błędu i informacje o debugowaniu.
target

string

Szczegółowy opis błędu i informacje o debugowaniu.

EventTriggerConfig

Wyzwalanie konfiguracji zadania sterowanego zdarzeniami.

Nazwa Typ Opis
parallelism

integer

Liczba równoległych replik zadania, które można uruchomić w danym momencie.
replicaCompletionCount

integer

Minimalna liczba pomyślnych ukończenia repliki przed ogólnym ukończeniem zadania.
scale

JobScale

Skalowanie konfiguracji dla zadań sterowanych zdarzeniami.

HttpGet

Element HTTPGet określa żądanie HTTP do wykonania.

Nazwa Typ Opis
host

string

Nazwa hosta, z którymi ma nawiązać połączenie, domyślnie jest to adres IP zasobnika. Prawdopodobnie zamiast tego chcesz ustawić wartość "Host" w elementach httpHeaders.
httpHeaders

HttpHeaders[]

Nagłówki niestandardowe do ustawienia w żądaniu. Protokół HTTP umożliwia powtarzające się nagłówki.
path

string

Ścieżka dostępu do serwera HTTP.
port

integer

Nazwa lub numer portu, aby uzyskać dostęp do kontenera. Liczba musi należeć do zakresu od 1 do 65535. Nazwa musi być IANA_SVC_NAME.
scheme

Scheme

Schemat używany do nawiązywania połączenia z hostem. Wartość domyślna to HTTP.

HttpHeaders

Nagłówki niestandardowe do ustawienia w żądaniu. Protokół HTTP zezwala na powtarzające się nagłówki.

Nazwa Typ Opis
name

string

Nazwa pola nagłówka
value

string

Wartość pola nagłówka

InitContainer

Definicja kontenera init aplikacji kontenera

Nazwa Typ Opis
args

string[]

Argumenty polecenia uruchamiania kontenera.
command

string[]

Polecenie uruchamiania kontenera.
env

EnvironmentVar[]

Zmienne środowiskowe kontenera.
image

string

Tag obrazu kontenera.
name

string

Niestandardowa nazwa kontenera.
resources

ContainerResources

Wymagania dotyczące zasobów kontenera.
volumeMounts

VolumeMount[]

Instalacja woluminu kontenera.

Job

Zadanie aplikacji kontenera

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

ManagedServiceIdentity

Tożsamości zarządzane wymagane przez zadanie aplikacji kontenera do interakcji z innymi usługami platformy Azure w celu nieutrzymywania żadnych wpisów tajnych ani poświadczeń w kodzie.
location

string

Lokalizacja geograficzna, w której znajduje się zasób
name

string

Nazwa zasobu
properties.configuration

JobConfiguration

Właściwości konfiguracji zadania usługi Container Apps.
properties.environmentId

string

Identyfikator zasobu środowiska.
properties.eventStreamEndpoint

string

Punkt końcowy zadania aplikacji kontenera w strumieniu zdarzeń.
properties.outboundIpAddresses

string[]

Wychodzące adresy IP zadania aplikacji kontenera.
properties.provisioningState

JobProvisioningState

Stan aprowizacji zadania usługi Container Apps.
properties.template

JobTemplate

Definicja zadania usługi Container Apps.
properties.workloadProfileName

string

Nazwa profilu obciążenia, który ma być przypięty do wykonania zadania aplikacji kontenera.
systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags

object

Tagi zasobów.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

JobConfiguration

Nieoparte na wersji właściwości konfiguracji zadania usługi Container Apps

Nazwa Typ Domyślna wartość Opis
eventTriggerConfig

EventTriggerConfig

Wyzwalanie konfiguracji zadania sterowanego zdarzeniami.
manualTriggerConfig

ManualTriggerConfig

Konfiguracja wyzwalacza ręcznego dla pojedynczego zadania wykonywania. Właściwości replicaCompletionCount i parallelism zostaną domyślnie ustawione na 1
registries

RegistryCredentials[]

Kolekcja prywatnych poświadczeń rejestru kontenerów używanych przez zadanie aplikacji kontenera
replicaRetryLimit

integer

Maksymalna liczba ponownych prób przed niepowodzeniem zadania.
replicaTimeout

integer

Maksymalna liczba sekund, przez które może działać replika.
scheduleTriggerConfig

ScheduleTriggerConfig

Harmonogram powtarzanych wyzwalaczy Cron ("* * * * *") dla cronjobs. Uzupełnianie właściwości i równoległość są domyślnie ustawione na 1
secrets

Secret[]

Zbieranie wpisów tajnych używanych przez zadanie usługi Container Apps
triggerType

TriggerType

Manual

Typ wyzwalacza zadania

JobProvisioningState

Stan aprowizacji zadania usługi Container Apps.

Nazwa Typ Opis
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

JobScale

Skalowanie konfiguracji dla zadań sterowanych zdarzeniami.

Nazwa Typ Domyślna wartość Opis
maxExecutions

integer

100

Maksymalna liczba wykonań zadań utworzonych dla wyzwalacza, domyślnie 100.
minExecutions

integer

0

Minimalna liczba wykonań zadań utworzonych dla wyzwalacza, wartość domyślna 0
pollingInterval

integer

Interwał sprawdzania każdego źródła zdarzeń w sekundach. Wartość domyślna to 30s
rules

JobScaleRule[]

Reguły skalowania.

JobScaleRule

Reguła skalowania.

Nazwa Typ Opis
auth

ScaleRuleAuth[]

Wpisy tajne uwierzytelniania dla reguły skalowania.
metadata

object

Właściwości metadanych opisujące regułę skalowania.
name

string

Nazwa reguły skalowania
type

string

Typ reguły skalowania, np. azure-servicebus, redis itp.

JobTemplate

Definicja aplikacji z wersją zadania usługi Container Apps. Definiuje żądany stan niezmiennej poprawki. Wszelkie zmiany w tej sekcji spowodują utworzenie nowej poprawki

Nazwa Typ Opis
containers

Container[]

Lista definicji kontenerów dla aplikacji kontenera.
initContainers

InitContainer[]

Lista wyspecjalizowanych kontenerów uruchamianych przed kontenerami aplikacji.
volumes

Volume[]

Lista definicji woluminów dla aplikacji kontenera.

ManagedServiceIdentity

Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub przypisane przez użytkownika)

Nazwa Typ Opis
principalId

string

Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId

string

Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
userAssignedIdentities

<string,  UserAssignedIdentity>

tożsamości User-Assigned
Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).

Nazwa Typ Opis
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManualTriggerConfig

Konfiguracja wyzwalacza ręcznego dla pojedynczego zadania wykonywania. Właściwości replicaCompletionCount i parallelism zostaną domyślnie ustawione na 1

Nazwa Typ Opis
parallelism

integer

Liczba równoległych replik zadania, które można uruchomić w danym momencie.
replicaCompletionCount

integer

Minimalna liczba pomyślnych ukończenia repliki przed ogólnym ukończeniem zadania.

RegistryCredentials

Rejestr prywatny aplikacji kontenera

Nazwa Typ Opis
identity

string

Tożsamość zarządzana używana do uwierzytelniania za pomocą Azure Container Registry. W przypadku tożsamości przypisanych przez użytkownika użyj pełnego identyfikatora zasobu tożsamości przypisanej przez użytkownika. W przypadku tożsamości przypisanych przez system użyj polecenia "system"
passwordSecretRef

string

Nazwa wpisu tajnego zawierającego hasło logowania rejestru
server

string

Serwer usługi Container Registry
username

string

Nazwa użytkownika usługi Container Registry

ScaleRuleAuth

Auth Secrets for Scale Rule

Nazwa Typ Opis
secretRef

string

Nazwa wpisu tajnego, z którego chcesz ściągnąć parametry uwierzytelniania.
triggerParameter

string

Parametr wyzwalacza, który używa wpisu tajnego

ScheduleTriggerConfig

Harmonogram powtarzanych wyzwalaczy Cron ("* * * * *") dla cronjobs. Uzupełnianie właściwości i równoległość są domyślnie ustawione na 1

Nazwa Typ Opis
cronExpression

string

Cron sformatował harmonogram powtarzania ("* * * * *") zadania Cron.
parallelism

integer

Liczba równoległych replik zadania, które można uruchomić w danym momencie.
replicaCompletionCount

integer

Minimalna liczba pomyślnych ukończenia repliki przed ogólnym ukończeniem zadania.

Scheme

Schemat używany do nawiązywania połączenia z hostem. Wartość domyślna to HTTP.

Nazwa Typ Opis
HTTP

string

HTTPS

string

Secret

Definicja wpisu tajnego.

Nazwa Typ Opis
identity

string

Identyfikator zasobu tożsamości zarządzanej do uwierzytelniania za pomocą usługi Azure Key Vault lub system do używania tożsamości przypisanej przez system.
keyVaultUrl

string

Adres URL usługi Azure Key Vault wskazujący wpis tajny przywołyny przez aplikację kontenera.
name

string

Nazwa wpisu tajnego.
value

string

Wartość wpisu tajnego.

SecretVolumeItem

Wpis tajny do dodania do woluminu.

Nazwa Typ Opis
path

string

Ścieżka do wpisu tajnego projektu. Jeśli nie podano ścieżki, ścieżka domyślnie określa nazwę wpisu tajnego wymienionego w secretRef.
secretRef

string

Nazwa wpisu tajnego aplikacji kontenera, z którego ma być ściągana wartość wpisu tajnego.

StorageType

Typ magazynu dla woluminu. Jeśli nie zostanie podana, użyj wartości EmptyDir.

Nazwa Typ Opis
AzureFile

string

EmptyDir

string

Secret

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).
createdBy

string

Tożsamość, która utworzyła zasób.
createdByType

createdByType

Typ tożsamości, która utworzyła zasób.
lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

TcpSocket

TcpSocket określa akcję obejmującą port TCP. Punkty zaczepienia TCP nie są jeszcze obsługiwane.

Nazwa Typ Opis
host

string

Opcjonalnie: Nazwa hosta, z którymi ma nawiązać połączenie, domyślnie jest to adres IP zasobnika.
port

integer

Numer lub nazwa portu, aby uzyskać dostęp do kontenera. Liczba musi należeć do zakresu od 1 do 65535. Nazwa musi być IANA_SVC_NAME.

TriggerType

Typ wyzwalacza zadania

Nazwa Typ Opis
Event

string

Manual

string

Schedule

string

Type

Typ sondy.

Nazwa Typ Opis
Liveness

string

Readiness

string

Startup

string

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Nazwa Typ Opis
clientId

string

Identyfikator klienta przypisanej tożsamości.
principalId

string

Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.

Volume

Definicje woluminów dla aplikacji kontenera.

Nazwa Typ Opis
mountOptions

string

Opcje instalacji używane podczas instalowania pliku AzureFile. Musi być ciągiem rozdzielanym przecinkami.
name

string

Nazwa woluminu.
secrets

SecretVolumeItem[]

Lista wpisów tajnych do dodania w woluminie. Jeśli nie podano żadnych wpisów tajnych, wszystkie wpisy tajne w kolekcji zostaną dodane do woluminu.
storageName

string

Nazwa zasobu magazynu. Nie trzeba podawać wartości EmptyDir i Secret.
storageType

StorageType

Typ magazynu dla woluminu. Jeśli nie zostanie podana, użyj wartości EmptyDir.

VolumeMount

Instalacja woluminu dla aplikacji kontenera.

Nazwa Typ Opis
mountPath

string

Ścieżka w kontenerze, w którym należy zamontować wolumin. Nie może zawierać ':'.
subPath

string

Ścieżka w woluminie, z którego należy zamontować wolumin kontenera. Wartość domyślna to "" (katalog główny woluminu).
volumeName

string

Musi to być zgodne z nazwą woluminu.