Jobs - Get

リファレンス

サービス:: Azure Container Apps

API バージョン:: 2024-03-01

Container Apps ジョブのプロパティを取得します。

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

URI パラメーター

名前	/	必須	型	説明
jobName	path	True	string	ジョブ名正規表現パターン: `^[-\w\._]+$`
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Job	OK です。
Other Status Codes	DefaultErrorResponse	一般的なエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get Container Apps Job

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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"
          }
        }
      ]
    }
  }
}

定義

名前	説明
Container	コンテナーアプリのコンテナー定義
ContainerAppProbe	プローブは、コンテナーに対して実行される正常性チェックを記述して、それがアクティブであるか、トラフィックを受信する準備ができているかを判断します。
ContainerResources	Container App コンテナーリソースの要件。
createdByType	リソースを作成した ID の種類。
DefaultErrorResponse	エラー応答をApp Serviceします。
Details	詳細またはエラー
EnvironmentVar	Container App コンテナー環境変数。
Error	エラーモデル。
EventTriggerConfig	イベントドリブンジョブの構成をトリガーします。
HttpGet	HTTPGet は、実行する http 要求を指定します。
HttpHeaders	要求で設定するカスタムヘッダー。 HTTP では、ヘッダーを繰り返すことができます。
InitContainer	コンテナーアプリの init コンテナー定義
Job	コンテナーアプリジョブ
JobConfiguration	バージョン管理されていない Container Apps ジョブの構成プロパティ
JobProvisioningState	Container Apps ジョブのプロビジョニング状態。
JobScale	イベントドリブンジョブの構成のスケーリング。
JobScaleRule	スケーリングルール。
JobTemplate	Container Apps ジョブのバージョン管理されたアプリケーション定義。変更できないリビジョンの目的の状態を定義します。このセクションを変更すると、新しいリビジョンが作成されます
ManagedServiceIdentity	マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
ManualTriggerConfig	1 つの実行ジョブの手動トリガー構成。プロパティ replicaCompletionCount と並列処理は、既定で 1 に設定されます
RegistryCredentials	Container App Private Registry
ScaleRuleAuth	スケールルールの認証シークレット
ScheduleTriggerConfig	cron は cronjobs の繰り返しトリガースケジュール ("* * * * *") を書式設定しました。プロパティの入力候補と並列処理は、既定で 1 に設定されます
Scheme	ホストへの接続に使用するスキーム。既定では HTTP です。
Secret	シークレット定義。
SecretVolumeItem	ボリュームに追加するシークレット。
StorageType	ボリュームのストレージの種類。指定しない場合は、EmptyDir を使用します。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TcpSocket	TCPSocket は、TCP ポートを含むアクションを指定します。 TCP フックはまだサポートされていません。
TriggerType	ジョブのトリガーの種類
Type	プローブの種類。
UserAssignedIdentity	ユーザー割り当て ID プロパティ
Volume	コンテナーアプリのボリューム定義。
VolumeMount	コンテナーアプリのボリュームマウント。

Container

コンテナーアプリのコンテナー定義

名前	型	説明
args	string[]	コンテナー開始コマンド引数。
command	string[]	コンテナー開始コマンド。
env	EnvironmentVar[]	コンテナー環境変数。
image	string	コンテナーイメージタグ。
name	string	カスタムコンテナー名。
probes	ContainerAppProbe[]	コンテナーのプローブの一覧。
resources	ContainerResources	コンテナーリソースの要件。
volumeMounts	VolumeMount[]	コンテナーボリュームのマウント。

ContainerAppProbe

プローブは、コンテナーに対して実行される正常性チェックを記述して、それがアクティブであるか、トラフィックを受信する準備ができているかを判断します。

名前	型	説明
failureThreshold	integer	プローブが成功した後に失敗したと見なされるプローブの連続する最小障害。既定値は 3 です。最大値は 1 です。最大値は 10 です。
httpGet	HttpGet	HTTPGet は、実行する http 要求を指定します。
initialDelaySeconds	integer	コンテナーの起動後、liveness probe が開始するまでの秒数。最大値は 1 です。最大値は 60 です。
periodSeconds	integer	プローブを実行する頻度 (秒単位)。既定値は 10 秒です。最大値は 1 です。最大値は 240 です。
successThreshold	integer	失敗した後にプローブが成功したと見なされる最小連続成功数。既定値は 1 です。ライブネスとスタートアップの場合は 1 にする必要があります。最大値は 1 です。最大値は 10 です。
tcpSocket	TcpSocket	TCPSocket は、TCP ポートを含むアクションを指定します。 TCP フックはまだサポートされていません。
terminationGracePeriodSeconds	integer	プローブの障害時にポッドを正常に終了する必要がある時間 (秒単位) (省略可能)。猶予期間は、ポッドで実行されているプロセスが終了シグナルを送信してから、プロセスが強制終了シグナルで強制的に停止された時間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、ポッドの terminationGracePeriodSeconds が使用されます。それ以外の場合、この値はポッドスペックによって提供される値をオーバーライドします。値は負以外の整数である必要があります。値 0 は、強制終了シグナルを介して直ちに停止することを示します (シャットダウンする機会はありません)。これはアルファフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最大値は 3600 秒 (1 時間) です
timeoutSeconds	integer	プローブがタイムアウトした秒数。既定値は 1 秒です。最大値は 1 です。最大値は 240 です。
type	Type	プローブの種類。

ContainerResources

Container App コンテナーリソースの要件。

名前	型	説明
cpu	number	コアに必要な CPU (例: 0.5)
ephemeralStorage	string	エフェメラルストレージ (例: "1Gi")
memory	string	必要なメモリ (例: "250Mb" )

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultErrorResponse

エラー応答をApp Serviceします。

名前	型	説明
error	Error	エラーモデル。

Details

詳細またはエラー

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

EnvironmentVar

Container App コンテナー環境変数。

名前	型	説明
name	string	環境変数名。
secretRef	string	環境変数の値をプルするコンテナーアプリシークレットの名前。
value	string	シークレット以外の環境変数値。

Error

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細またはエラー
innererror	string	エラーのデバッグに関する詳細情報。
message	string	詳細なエラーの説明とデバッグ情報。
target	string	詳細なエラーの説明とデバッグ情報。

EventTriggerConfig

イベントドリブンジョブの構成をトリガーします。

名前	型	説明
parallelism	integer	特定の時刻に実行できるジョブの並列レプリカの数。
replicaCompletionCount	integer	ジョブ全体の完了前にレプリカが正常に完了した最小数。
scale	JobScale	イベントドリブンジョブのスケーリング構成。

HttpGet

HTTPGet は、実行する http 要求を指定します。

名前	型	説明
host	string	接続先のホスト名。既定ではポッド IP です。代わりに httpHeaders で "Host" を設定することをお考えでしょう。
httpHeaders	HttpHeaders[]	要求で設定するカスタムヘッダー。 HTTP では、ヘッダーを繰り返し使用できます。
path	string	HTTP サーバーでアクセスするためのパス。
port	integer	コンテナーでアクセスするポートの名前または番号。数値は 1 ~ 65535 の範囲である必要があります。名前はIANA_SVC_NAMEである必要があります。
scheme	Scheme	ホストへの接続に使用するスキーム。既定では HTTP です。

HttpHeaders

要求で設定するカスタムヘッダー。 HTTP では、ヘッダーを繰り返すことができます。

名前	型	説明
name	string	ヘッダーフィールド名
value	string	ヘッダーフィールドの値

InitContainer

コンテナーアプリの init コンテナー定義

名前	型	説明
args	string[]	コンテナー開始コマンド引数。
command	string[]	コンテナー開始コマンド。
env	EnvironmentVar[]	コンテナー環境変数。
image	string	コンテナーイメージタグ。
name	string	カスタムコンテナー名。
resources	ContainerResources	コンテナーリソースの要件。
volumeMounts	VolumeMount[]	コンテナーボリュームのマウント。

Job

コンテナーアプリジョブ

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	コード内のシークレットや資格情報を保持しないように、他の Azure サービスと対話するためにコンテナーアプリジョブで必要なマネージド ID。
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.configuration	JobConfiguration	Container Apps ジョブの構成プロパティ。
properties.environmentId	string	環境のリソース ID。
properties.eventStreamEndpoint	string	コンテナーアプリジョブの eventstream のエンドポイント。
properties.outboundIpAddresses	string[]	コンテナーアプリジョブの送信 IP アドレス。
properties.provisioningState	JobProvisioningState	Container Apps ジョブのプロビジョニング状態。
properties.template	JobTemplate	Container Apps ジョブ定義。
properties.workloadProfileName	string	コンテナーアプリジョブの実行にピン留めするワークロードプロファイル名。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

JobConfiguration

バージョン管理されていない Container Apps ジョブの構成プロパティ

名前	型	規定値	説明
eventTriggerConfig	EventTriggerConfig		イベントドリブンジョブの構成をトリガーします。
manualTriggerConfig	ManualTriggerConfig		1 つの実行ジョブの手動トリガー構成。プロパティ replicaCompletionCount と並列処理は、既定で 1 に設定されます
registries	RegistryCredentials[]		Container apps ジョブで使用されるプライベートコンテナーレジストリ資格情報のコレクション
replicaRetryLimit	integer		ジョブが失敗するまでの再試行の最大数。
replicaTimeout	integer		レプリカの実行が許可される最大秒数。
scheduleTriggerConfig	ScheduleTriggerConfig		cron は cronjobs の繰り返しトリガースケジュール ("* * * * *") を書式設定しました。プロパティの入力候補と並列処理は、既定で 1 に設定されます
secrets	Secret[]		Container Apps ジョブによって使用されるシークレットのコレクション
triggerType	TriggerType	Manual	ジョブのトリガーの種類

JobProvisioningState

Container Apps ジョブのプロビジョニング状態。

名前	型	説明
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

JobScale

イベントドリブンジョブの構成のスケーリング。

名前	型	規定値	説明
maxExecutions	integer	100	トリガーに対して作成されるジョブ実行の最大数(既定値は 100)。
minExecutions	integer	0	トリガーに対して作成されるジョブ実行の最小数(既定値は 0)
pollingInterval	integer		各イベントソースを秒単位でチェックする間隔。既定値は 30 秒です
rules	JobScaleRule[]		スケーリングルール。

JobScaleRule

スケーリングルール。

名前	型	説明
auth	ScaleRuleAuth[]	スケールルールの認証シークレット。
metadata	object	スケールルールを記述するためのメタデータプロパティ。
name	string	スケールルール名
type	string	スケールルールの種類 (例: azure-servicebus、redis など)。

JobTemplate

Container Apps ジョブのバージョン管理されたアプリケーション定義。変更できないリビジョンの目的の状態を定義します。このセクションを変更すると、新しいリビジョンが作成されます

名前	型	説明
containers	Container[]	コンテナーアプリのコンテナー定義の一覧。
initContainers	InitContainer[]	アプリコンテナーの前に実行される特殊なコンテナーの一覧。
volumes	Volume[]	コンテナーアプリのボリューム定義の一覧。

ManagedServiceIdentity

マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)

名前	型	説明
principalId	string	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
type	ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManualTriggerConfig

1 つの実行ジョブの手動トリガー構成。プロパティ replicaCompletionCount と並列処理は、既定で 1 に設定されます

名前	型	説明
parallelism	integer	特定の時刻に実行できるジョブの並列レプリカの数。
replicaCompletionCount	integer	ジョブ全体の完了前にレプリカが正常に完了した最小数。

RegistryCredentials

Container App Private Registry

名前	型	説明
identity	string	Azure Container Registryで認証するために使用するマネージド ID。ユーザー割り当て ID の場合は、完全なユーザー割り当て ID リソース ID を使用します。システム割り当て ID の場合は、'system' を使用します
passwordSecretRef	string	レジストリログインパスワードを含むシークレットの名前
server	string	コンテナーレジストリサーバー
username	string	コンテナーレジストリのユーザー名

ScaleRuleAuth

スケールルールの認証シークレット

名前	型	説明
secretRef	string	認証パラメーターをプルするシークレットの名前。
triggerParameter	string	シークレットを使用するトリガーパラメーター

ScheduleTriggerConfig

cron は cronjobs の繰り返しトリガースケジュール ("* * * * *") を書式設定しました。プロパティの入力候補と並列処理は、既定で 1 に設定されます

名前	型	説明
cronExpression	string	Cron は、Cron ジョブの繰り返しスケジュール ("* * * * *") を書式設定しました。
parallelism	integer	特定の時刻に実行できるジョブの並列レプリカの数。
replicaCompletionCount	integer	ジョブ全体の完了前にレプリカが正常に完了した最小数。

Scheme

ホストへの接続に使用するスキーム。既定では HTTP です。

名前	型	説明
HTTP	string
HTTPS	string

Secret

シークレット定義。

名前	型	説明
identity	string	Azure Key Vaultで認証するマネージド ID のリソース ID、またはシステム割り当て ID を使用するシステム。
keyVaultUrl	string	コンテナーアプリによって参照されるシークレットを指す Azure Key Vault URL。
name	string	シークレット名。
value	string	シークレット値。

SecretVolumeItem

ボリュームに追加するシークレット。

名前	型	説明
path	string	プロジェクトシークレットのパス。パスが指定されていない場合、path は既定で secretRef にリストされているシークレットの名前になります。
secretRef	string	シークレット値をプルするコンテナーアプリシークレットの名前。

StorageType

ボリュームのストレージの種類。指定しない場合は、EmptyDir を使用します。

名前	型	説明
AzureFile	string
EmptyDir	string
Secret	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TcpSocket

TCPSocket は、TCP ポートを含むアクションを指定します。 TCP フックはまだサポートされていません。

名前	型	説明
host	string	省略可能: 接続先のホスト名。既定値はポッド IP です。
port	integer	コンテナーでアクセスするポートの番号または名前。数値は 1 ~ 65535 の範囲である必要があります。名前はIANA_SVC_NAMEである必要があります。

TriggerType

ジョブのトリガーの種類

名前	型	説明
Event	string
Manual	string
Schedule	string

Type

プローブの種類。

名前	型	説明
Liveness	string
Readiness	string
Startup	string

UserAssignedIdentity

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string	割り当てられた ID のクライアント ID。
principalId	string	割り当てられた ID のプリンシパル ID。

Volume

コンテナーアプリのボリューム定義。

名前	型	説明
mountOptions	string	AzureFile のマウント時に使用されるマウントオプション。コンマ区切りの文字列である必要があります。
name	string	ボリューム名。
secrets	SecretVolumeItem[]	ボリュームに追加するシークレットの一覧。シークレットが指定されていない場合、コレクション内のすべてのシークレットがボリュームに追加されます。
storageName	string	ストレージリソースの名前。 EmptyDir とシークレットを指定する必要はありません。
storageType	StorageType	ボリュームのストレージの種類。指定しない場合は、EmptyDir を使用します。

VolumeMount

コンテナーアプリのボリュームマウント。

名前	型	説明
mountPath	string	ボリュームをマウントするコンテナー内のパス。':' を含めてはなりません。
subPath	string	コンテナーのボリュームをマウントするボリューム内のパス。既定値は "" (ボリュームのルート) です。
volumeName	string	これは、ボリュームの名前と一致する必要があります。

次の方法で共有