你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Jobs - Get
获取容器应用作业的属性。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}?api-version=2024-03-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
job
|
path | True |
string |
作业名称 正则表达式模式: |
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 |
|
Other Status Codes |
常见错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Get Container Apps Job
示例请求
示例响应
{
"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 |
容器应用容器定义 |
Container |
探测描述要对容器执行的运行状况检查,以确定容器是处于活动状态还是已准备好接收流量。 |
Container |
容器应用容器资源要求。 |
created |
创建资源的标识类型。 |
Default |
App 服务错误响应。 |
Details |
详细信息或错误 |
Environment |
容器应用容器环境变量。 |
Error |
错误模型。 |
Event |
事件驱动作业的触发器配置。 |
Http |
HTTPGet 指定要执行的 http 请求。 |
Http |
在请求中设置的自定义标头。 HTTP 允许重复标头。 |
Init |
容器应用初始化容器定义 |
Job |
容器应用作业 |
Job |
非版本控制容器应用作业配置属性 |
Job |
容器应用作业的预配状态。 |
Job |
事件驱动作业的缩放配置。 |
Job |
缩放规则。 |
Job |
容器应用 作业版本控制的应用程序定义。 定义不可变修订的所需状态。 对此部分所做的任何更改都将导致创建新的修订 |
Managed |
托管服务标识 (系统分配的标识和/或用户分配的标识) |
Managed |
) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。 |
Manual |
单个执行作业的手动触发器配置。 默认情况下,属性 replicaCompletionCount 和并行度将设置为 1 |
Registry |
容器应用专用注册表 |
Scale |
缩放规则的身份验证机密 |
Schedule |
Cron 格式化的重复触发器计划 (“* * * * *”) cronjobs。 默认情况下,属性完成和并行度将设置为 1 |
Scheme |
用于连接到主机的方案。 默认为 HTTP。 |
Secret |
机密定义。 |
Secret |
要添加到卷的机密。 |
Storage |
卷的存储类型。 如果未提供,请使用 EmptyDir。 |
system |
与资源的创建和上次修改相关的元数据。 |
Tcp |
TCPSocket 指定涉及 TCP 端口的操作。 尚不支持 TCP 挂钩。 |
Trigger |
作业的触发器类型 |
Type |
探测的类型。 |
User |
用户分配的标识属性 |
Volume |
容器应用的卷定义。 |
Volume |
容器应用的卷装载。 |
Container
容器应用容器定义
名称 | 类型 | 说明 |
---|---|---|
args |
string[] |
容器启动命令参数。 |
command |
string[] |
容器启动命令。 |
env |
容器环境变量。 |
|
image |
string |
容器映像标记。 |
name |
string |
自定义容器名称。 |
probes |
容器的探测列表。 |
|
resources |
容器资源要求。 |
|
volumeMounts |
容器卷装载。 |
ContainerAppProbe
探测描述要对容器执行的运行状况检查,以确定容器是处于活动状态还是已准备好接收流量。
名称 | 类型 | 说明 |
---|---|---|
failureThreshold |
integer |
在成功后,要被视为失败的探测的最小连续失败次数。 默认值为 3。 最小值为 1。 最大值为 10。 |
httpGet |
HTTPGet 指定要执行的 http 请求。 |
|
initialDelaySeconds |
integer |
启动容器后,启动运行情况探测前的秒数。 最小值为 1。 最大值为 60。 |
periodSeconds |
integer |
执行探测的频率(以秒为单位)。 默认值为 10 秒。 最小值为 1。 最大值为 240。 |
successThreshold |
integer |
失败后,要被视为成功的探测的最小连续成功。 默认值为 1。 对于运行和启动,必须为 1。 最小值为 1。 最大值为 10。 |
tcpSocket |
TCPSocket 指定涉及 TCP 端口的操作。 尚不支持 TCP 挂钩。 |
|
terminationGracePeriodSeconds |
integer |
探测失败时 Pod 需要正常终止的可选持续时间(以秒为单位)。 宽限期是向 Pod 中运行的进程发送终止信号之后的持续时间(以秒为单位)以及用终止信号强行停止进程的时间。 请将此值设置为大于你的进程的预期清理时间。 如果此值为 nil,将使用 Pod 的 terminationGracePeriodSeconds。 否则,此值将替代 Pod 规范提供的值。值必须是非负整数。 值 0 指示通过终止信号立即停止, (没有机会关闭) 。 这是一个 alpha 字段,需要启用 ProbeTerminationGracePeriod 功能门。 最大值为 3600 秒 (1 小时) |
timeoutSeconds |
integer |
探测超时的秒数。默认为 1 秒。 最小值为 1。 最大值为 240。 |
type |
探测的类型。 |
ContainerResources
容器应用容器资源要求。
名称 | 类型 | 说明 |
---|---|---|
cpu |
number |
核心中所需的 CPU,例如 0.5 |
ephemeralStorage |
string |
临时存储,例如“1Gi” |
memory |
string |
所需内存,例如“250Mb” |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultErrorResponse
App 服务错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误模型。 |
Details
详细信息或错误
名称 | 类型 | 说明 |
---|---|---|
code |
string |
标准化字符串,用于以编程方式标识错误。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
EnvironmentVar
容器应用容器环境变量。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
环境变量名称。 |
secretRef |
string |
要从中提取环境变量值的容器应用机密的名称。 |
value |
string |
非机密环境变量值。 |
Error
错误模型。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
标准化字符串,用于以编程方式标识错误。 |
details |
Details[] |
详细信息或错误 |
innererror |
string |
调试错误的详细信息。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
EventTriggerConfig
事件驱动作业的触发器配置。
名称 | 类型 | 说明 |
---|---|---|
parallelism |
integer |
可以在给定时间运行的作业的并行副本数。 |
replicaCompletionCount |
integer |
在完成整个作业之前成功完成副本 (replica) 的最小数目。 |
scale |
事件驱动作业的缩放配置。 |
HttpGet
HTTPGet 指定要执行的 http 请求。
名称 | 类型 | 说明 |
---|---|---|
host |
string |
要连接到的主机名,默认为 Pod IP。 你可能想要改为在 httpHeaders 中设置“主机”。 |
httpHeaders |
在请求中设置的自定义标头。 HTTP 允许重复标头。 |
|
path |
string |
HTTP 服务器上的访问路径。 |
port |
integer |
要在容器上访问的端口的名称或编号。 数字必须在 1 到 65535 的范围内。 名称必须是IANA_SVC_NAME。 |
scheme |
用于连接到主机的方案。 默认为 HTTP。 |
HttpHeaders
在请求中设置的自定义标头。 HTTP 允许重复标头。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
标头字段名称 |
value |
string |
标头字段值 |
InitContainer
容器应用初始化容器定义
名称 | 类型 | 说明 |
---|---|---|
args |
string[] |
容器启动命令参数。 |
command |
string[] |
容器启动命令。 |
env |
容器环境变量。 |
|
image |
string |
容器映像标记。 |
name |
string |
自定义容器名称。 |
resources |
容器资源要求。 |
|
volumeMounts |
容器卷装载。 |
Job
容器应用作业
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
容器应用作业与其他 Azure 服务交互所需的托管标识,以不维护代码中的任何机密或凭据。 |
|
location |
string |
资源所在的地理位置 |
name |
string |
资源的名称 |
properties.configuration |
容器应用作业配置属性。 |
|
properties.environmentId |
string |
环境的资源 ID。 |
properties.eventStreamEndpoint |
string |
容器应用作业的事件流的终结点。 |
properties.outboundIpAddresses |
string[] |
容器应用作业的出站 IP 地址。 |
properties.provisioningState |
容器应用作业的预配状态。 |
|
properties.template |
容器应用作业定义。 |
|
properties.workloadProfileName |
string |
用于固定容器应用作业执行的工作负荷配置文件名称。 |
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
tags |
object |
资源标记。 |
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
JobConfiguration
非版本控制容器应用作业配置属性
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
eventTriggerConfig |
事件驱动作业的触发器配置。 |
||
manualTriggerConfig |
单个执行作业的手动触发器配置。 默认情况下,属性 replicaCompletionCount 和并行度将设置为 1 |
||
registries |
容器应用作业使用的专用容器注册表凭据的集合 |
||
replicaRetryLimit |
integer |
作业失败前的最大重试次数。 |
|
replicaTimeout |
integer |
允许运行副本 (replica) 的最大秒数。 |
|
scheduleTriggerConfig |
Cron 格式化的重复触发器计划 (“* * * * *”) cronjobs。 默认情况下,属性完成和并行度将设置为 1 |
||
secrets |
Secret[] |
容器应用作业使用的机密集合 |
|
triggerType | Manual |
作业的触发器类型 |
JobProvisioningState
容器应用作业的预配状态。
名称 | 类型 | 说明 |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
JobScale
事件驱动作业的缩放配置。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
maxExecutions |
integer |
100 |
为触发器创建的作业执行的最大数目,默认值为 100。 |
minExecutions |
integer |
0 |
为触发器创建的最小作业执行数,默认值为 0 |
pollingInterval |
integer |
检查每个事件源的间隔(以秒为单位)。 默认值为 30s |
|
rules |
缩放规则。 |
JobScaleRule
缩放规则。
名称 | 类型 | 说明 |
---|---|---|
auth |
缩放规则的身份验证机密。 |
|
metadata |
object |
描述缩放规则的元数据属性。 |
name |
string |
缩放规则名称 |
type |
string |
缩放规则的类型,例如:azure-servicebus、redis 等。 |
JobTemplate
容器应用 作业版本控制的应用程序定义。 定义不可变修订的所需状态。 对此部分所做的任何更改都将导致创建新的修订
名称 | 类型 | 说明 |
---|---|---|
containers |
容器应用的容器定义列表。 |
|
initContainers |
在应用容器之前运行的专用容器列表。 |
|
volumes |
Volume[] |
容器应用的卷定义列表。 |
ManagedServiceIdentity
托管服务标识 (系统分配的标识和/或用户分配的标识)
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
系统分配的标识的服务主体 ID。 此属性仅针对系统分配的标识提供。 |
tenantId |
string |
系统分配的标识的租户 ID。 此属性仅针对系统分配的标识提供。 |
type |
) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。 |
|
userAssignedIdentities |
<string,
User |
User-Assigned 标识 |
ManagedServiceIdentityType
) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
ManualTriggerConfig
单个执行作业的手动触发器配置。 默认情况下,属性 replicaCompletionCount 和并行度将设置为 1
名称 | 类型 | 说明 |
---|---|---|
parallelism |
integer |
可以在给定时间运行的作业的并行副本数。 |
replicaCompletionCount |
integer |
在完成整个作业之前成功完成副本 (replica) 的最小数目。 |
RegistryCredentials
容器应用专用注册表
名称 | 类型 | 说明 |
---|---|---|
identity |
string |
用于对Azure 容器注册表进行身份验证的托管标识。 对于用户分配的标识,请使用完整的用户分配标识资源 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 |
在完成整个作业之前成功完成副本 (replica) 的最小数目。 |
Scheme
用于连接到主机的方案。 默认为 HTTP。
名称 | 类型 | 说明 |
---|---|---|
HTTP |
string |
|
HTTPS |
string |
Secret
机密定义。
名称 | 类型 | 说明 |
---|---|---|
identity |
string |
使用 Azure 密钥保管库进行身份验证的托管标识的资源 ID,或者使用系统分配的标识。 |
keyVaultUrl |
string |
Azure 密钥保管库指向容器应用引用的机密的 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 |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |
TcpSocket
TCPSocket 指定涉及 TCP 端口的操作。 尚不支持 TCP 挂钩。
名称 | 类型 | 说明 |
---|---|---|
host |
string |
可选:要连接到的主机名,默认为 Pod IP。 |
port |
integer |
要在容器上访问的端口的数量或名称。 数字必须在 1 到 65535 的范围内。 名称必须是IANA_SVC_NAME。 |
TriggerType
作业的触发器类型
名称 | 类型 | 说明 |
---|---|---|
Event |
string |
|
Manual |
string |
|
Schedule |
string |
Type
探测的类型。
名称 | 类型 | 说明 |
---|---|---|
Liveness |
string |
|
Readiness |
string |
|
Startup |
string |
UserAssignedIdentity
用户分配的标识属性
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
已分配标识的客户端 ID。 |
principalId |
string |
分配的标识的主体 ID。 |
Volume
容器应用的卷定义。
名称 | 类型 | 说明 |
---|---|---|
mountOptions |
string |
装载 AzureFile 时使用的装载选项。 必须是逗号分隔的字符串。 |
name |
string |
卷名。 |
secrets |
要添加到卷中的机密列表。 如果未提供机密,则集合中的所有机密都将添加到卷中。 |
|
storageName |
string |
存储资源的名称。 无需提供 EmptyDir 和 Secret。 |
storageType |
卷的存储类型。 如果未提供,请使用 EmptyDir。 |
VolumeMount
容器应用的卷装载。
名称 | 类型 | 说明 |
---|---|---|
mountPath |
string |
容器中应装载卷的路径。不得包含“:”。 |
subPath |
string |
应从中装载容器卷的卷中的路径。 默认为“” (卷的根) 。 |
volumeName |
string |
这必须与卷的名称匹配。 |