diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/Jobs.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/Jobs.json index ff646d6f5573..b64f024c7494 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/Jobs.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/Jobs.json @@ -111,12 +111,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$" + "$ref": "#/parameters/JobNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -157,11 +152,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string" + "$ref": "#/parameters/JobNameParameter" }, { "name": "JobEnvelope", @@ -224,11 +215,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string" + "$ref": "#/parameters/JobNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -281,11 +268,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string" + "$ref": "#/parameters/JobNameParameter" }, { "name": "JobEnvelope", @@ -345,12 +328,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$" + "$ref": "#/parameters/JobNameParameter" }, { "name": "template", @@ -416,20 +394,10 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$" + "$ref": "#/parameters/JobNameParameter" }, { - "name": "jobExecutionName", - "in": "path", - "description": "Job execution name.", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$" + "$ref": "#/parameters/JobExecutionNameParameter" } ], "responses": { @@ -480,21 +448,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$" - }, - { - "name": "jobExecutionName", - "in": "body", - "description": "List of all job executions that should be stopped.", - "required": true, - "schema": { - "$ref": "#/definitions/JobExecutionNamesCollection" - } + "$ref": "#/parameters/JobNameParameter" } ], "responses": { @@ -545,12 +499,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$" + "$ref": "#/parameters/JobNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -587,6 +536,51 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get details of a single job execution", + "operationId": "JobExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/JobExecutionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobExecution" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a single Job Execution": { + "$ref": "./examples/Job_Execution_Get.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/listSecrets": { "post": { "tags": [ @@ -605,12 +599,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "name": "jobName", - "in": "path", - "description": "Name of the Container Apps Job.", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$" + "$ref": "#/parameters/JobNameParameter" } ], "responses": { @@ -635,6 +624,24 @@ } } }, + "parameters": { + "JobNameParameter": { + "name": "jobName", + "in": "path", + "description": "Job Name", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + "JobExecutionNameParameter": { + "name": "jobExecutionName", + "in": "path", + "description": "Job execution name.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + } + }, "definitions": { "JobConfiguration": { "description": "Non versioned Container Apps Job configuration properties", @@ -950,7 +957,7 @@ } }, "JobExecution": { - "description": "Container Apps Jobs execution.", + "description": "Container Apps Job execution.", "type": "object", "properties": { "name": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json new file mode 100644 index 000000000000..996574bb0da3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "jobExecutionName": "jobExecution1", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "jobExecution1", + "status": "Running", + "startTime": "2023-02-13T20:37:30+00:00", + "endTime": "2023-02-13T20:47:30+00:00", + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + } +}