Skip to content

Commit b5e1ee6

Browse files
edwin-msftShubham Dhondweidongxu-microsoft
authored
Fork/web ant97 2022 03 01 (#19259)
* Added DeploymentStatus API specs and examples * change status to enum, rm extra dot * suppress missing examples for now * rm id from List Deployment Slot examples * rm location, and rename deploymentId in GetSiteDeploymentStatus examples * change model as string to true, add 202 operations for DeploymentStatus ops to spec * rename operationId to deploymentStatusId, undo deploymentId rename * add long running op, as per linter Co-authored-by: Shubham Dhond <[email protected]> Co-authored-by: Weidong Xu <[email protected]>
1 parent 174630a commit b5e1ee6

File tree

6 files changed

+457
-0
lines changed

6 files changed

+457
-0
lines changed

‎specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json

Lines changed: 328 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2872,6 +2872,115 @@
28722872
}
28732873
}
28742874
},
2875+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus": {
2876+
"get": {
2877+
"tags": [
2878+
"WebApps"
2879+
],
2880+
"summary": "List deployment statuses for an app (or deployment slot, if specified).",
2881+
"operationId": "WebApps_ListProductionSiteDeploymentStatuses",
2882+
"parameters": [
2883+
{
2884+
"$ref": "#/parameters/resourceGroupNameParameter"
2885+
},
2886+
{
2887+
"name": "name",
2888+
"in": "path",
2889+
"description": "Name of the app.",
2890+
"required": true,
2891+
"type": "string"
2892+
},
2893+
{
2894+
"$ref": "#/parameters/subscriptionIdParameter"
2895+
},
2896+
{
2897+
"$ref": "#/parameters/apiVersionParameter"
2898+
}
2899+
],
2900+
"responses": {
2901+
"200": {
2902+
"description": "OK",
2903+
"schema": {
2904+
"$ref": "#/definitions/CsmDeploymentStatusCollection"
2905+
}
2906+
},
2907+
"default": {
2908+
"description": "App Service error response.",
2909+
"schema": {
2910+
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
2911+
}
2912+
}
2913+
},
2914+
"x-ms-examples": {
2915+
"List Deployment Status": {
2916+
"$ref": "./examples/ListSiteDeploymentStatus.json"
2917+
}
2918+
},
2919+
"x-ms-pageable": {
2920+
"nextLinkName": "nextLink"
2921+
}
2922+
}
2923+
},
2924+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}": {
2925+
"get": {
2926+
"tags": [
2927+
"WebApps"
2928+
],
2929+
"summary": "Gets the deployment status for an app (or deployment slot, if specified).",
2930+
"operationId": "WebApps_GetProductionSiteDeploymentStatus",
2931+
"parameters": [
2932+
{
2933+
"$ref": "#/parameters/subscriptionIdParameter"
2934+
},
2935+
{
2936+
"$ref": "#/parameters/resourceGroupNameParameter"
2937+
},
2938+
{
2939+
"name": "name",
2940+
"in": "path",
2941+
"description": "Name of the app.",
2942+
"required": true,
2943+
"type": "string"
2944+
},
2945+
{
2946+
"name": "deploymentStatusId",
2947+
"in": "path",
2948+
"description": "GUID of the deployment operation.",
2949+
"required": true,
2950+
"type": "string"
2951+
},
2952+
{
2953+
"$ref": "#/parameters/apiVersionParameter"
2954+
}
2955+
],
2956+
"responses": {
2957+
"200": {
2958+
"description": "OK",
2959+
"schema": {
2960+
"$ref": "#/definitions/CsmDeploymentStatus"
2961+
}
2962+
},
2963+
"202": {
2964+
"description": "Operation is in progress.",
2965+
"schema": {
2966+
"$ref": "#/definitions/CsmDeploymentStatus"
2967+
}
2968+
},
2969+
"default": {
2970+
"description": "App Service error response.",
2971+
"schema": {
2972+
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
2973+
}
2974+
}
2975+
},
2976+
"x-ms-examples": {
2977+
"Get Deployment Status": {
2978+
"$ref": "./examples/GetSiteDeploymentStatus.json"
2979+
}
2980+
},
2981+
"x-ms-long-running-operation": true
2982+
}
2983+
},
28752984
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": {
28762985
"get": {
28772986
"tags": [
@@ -11677,6 +11786,129 @@
1167711786
}
1167811787
}
1167911788
},
11789+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus": {
11790+
"get": {
11791+
"tags": [
11792+
"WebApps"
11793+
],
11794+
"summary": "List deployment statuses for an app (or deployment slot, if specified).",
11795+
"operationId": "WebApps_ListSlotSiteDeploymentStatusesSlot",
11796+
"parameters": [
11797+
{
11798+
"$ref": "#/parameters/resourceGroupNameParameter"
11799+
},
11800+
{
11801+
"name": "name",
11802+
"in": "path",
11803+
"description": "Name of the app.",
11804+
"required": true,
11805+
"type": "string"
11806+
},
11807+
{
11808+
"name": "slot",
11809+
"in": "path",
11810+
"description": "Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.",
11811+
"required": true,
11812+
"type": "string"
11813+
},
11814+
{
11815+
"$ref": "#/parameters/subscriptionIdParameter"
11816+
},
11817+
{
11818+
"$ref": "#/parameters/apiVersionParameter"
11819+
}
11820+
],
11821+
"responses": {
11822+
"200": {
11823+
"description": "OK",
11824+
"schema": {
11825+
"$ref": "#/definitions/CsmDeploymentStatusCollection"
11826+
}
11827+
},
11828+
"default": {
11829+
"description": "App Service error response.",
11830+
"schema": {
11831+
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
11832+
}
11833+
}
11834+
},
11835+
"x-ms-examples": {
11836+
"List Deployment Status Slot": {
11837+
"$ref": "./examples/ListSiteDeploymentStatusSlot.json"
11838+
}
11839+
},
11840+
"x-ms-pageable": {
11841+
"nextLinkName": "nextLink"
11842+
}
11843+
}
11844+
},
11845+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId}": {
11846+
"get": {
11847+
"tags": [
11848+
"WebApps"
11849+
],
11850+
"summary": "Gets the deployment status for an app (or deployment slot, if specified).",
11851+
"operationId": "WebApps_GetSlotSiteDeploymentStatusSlot",
11852+
"parameters": [
11853+
{
11854+
"$ref": "#/parameters/subscriptionIdParameter"
11855+
},
11856+
{
11857+
"$ref": "#/parameters/resourceGroupNameParameter"
11858+
},
11859+
{
11860+
"name": "name",
11861+
"in": "path",
11862+
"description": "Name of the app.",
11863+
"required": true,
11864+
"type": "string"
11865+
},
11866+
{
11867+
"name": "slot",
11868+
"in": "path",
11869+
"description": "Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.",
11870+
"required": true,
11871+
"type": "string"
11872+
},
11873+
{
11874+
"name": "deploymentStatusId",
11875+
"in": "path",
11876+
"description": "GUID of the deployment operation.",
11877+
"required": true,
11878+
"type": "string"
11879+
},
11880+
{
11881+
"$ref": "#/parameters/apiVersionParameter"
11882+
}
11883+
],
11884+
"responses": {
11885+
"200": {
11886+
"description": "OK",
11887+
"schema": {
11888+
"$ref": "#/definitions/CsmDeploymentStatus"
11889+
}
11890+
},
11891+
"202": {
11892+
"description": "Operation is in progress.",
11893+
"schema": {
11894+
"$ref": "#/definitions/CsmDeploymentStatus"
11895+
}
11896+
},
11897+
"default": {
11898+
"description": "App Service error response.",
11899+
"schema": {
11900+
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
11901+
}
11902+
}
11903+
},
11904+
"x-ms-examples": {
11905+
"Get Deployment Status Slot": {
11906+
"$ref": "./examples/GetSiteDeploymentStatusSlot.json"
11907+
}
11908+
},
11909+
"x-ms-long-running-operation": true
11910+
}
11911+
},
1168011912
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": {
1168111913
"get": {
1168211914
"tags": [
@@ -22339,6 +22571,102 @@
2233922571
}
2234022572
}
2234122573
},
22574+
"CsmDeploymentStatus": {
22575+
"description": "Deployment status response payload.",
22576+
"type": "object",
22577+
"allOf": [
22578+
{
22579+
"$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
22580+
}
22581+
],
22582+
"properties": {
22583+
"properties": {
22584+
"description": "CsmDeploymentStatus resource specific properties",
22585+
"type": "object",
22586+
"properties": {
22587+
"deploymentId": {
22588+
"description": "Deployment operation id.",
22589+
"type": "string"
22590+
},
22591+
"status": {
22592+
"description": "Deployment build status.",
22593+
"enum": [
22594+
"TimedOut",
22595+
"RuntimeFailed",
22596+
"BuildAborted",
22597+
"BuildFailed",
22598+
"BuildRequestReceived",
22599+
"BuildPending",
22600+
"BuildInProgress",
22601+
"BuildSuccessful",
22602+
"PostBuildRestartRequired",
22603+
"StartPolling",
22604+
"StartPollingWithRestart",
22605+
"RuntimeStarting",
22606+
"RuntimeSuccessful"
22607+
],
22608+
"type": "string",
22609+
"x-ms-enum": {
22610+
"name": "DeploymentBuildStatus",
22611+
"modelAsString": true
22612+
}
22613+
},
22614+
"numberOfInstancesInProgress": {
22615+
"format": "int32",
22616+
"description": "Number of site instances currently being provisioned.",
22617+
"type": "integer"
22618+
},
22619+
"numberOfInstancesSuccessful": {
22620+
"format": "int32",
22621+
"description": "Number of site instances provisioned successfully.",
22622+
"type": "integer"
22623+
},
22624+
"numberOfInstancesFailed": {
22625+
"format": "int32",
22626+
"description": "Number of site instances failed to provision.",
22627+
"type": "integer"
22628+
},
22629+
"failedInstancesLogs": {
22630+
"description": "List of URLs pointing to logs for instances which failed to provision.",
22631+
"type": "array",
22632+
"items": {
22633+
"type": "string"
22634+
}
22635+
},
22636+
"errors": {
22637+
"description": "List of errors.",
22638+
"type": "array",
22639+
"items": {
22640+
"$ref": "./CommonDefinitions.json#/definitions/ErrorEntity"
22641+
},
22642+
"x-ms-identifiers": []
22643+
}
22644+
},
22645+
"x-ms-client-flatten": true
22646+
}
22647+
}
22648+
},
22649+
"CsmDeploymentStatusCollection": {
22650+
"description": "Deployment status collection ARM resource.",
22651+
"required": [
22652+
"value"
22653+
],
22654+
"type": "object",
22655+
"properties": {
22656+
"value": {
22657+
"description": "Collection of resources.",
22658+
"type": "array",
22659+
"items": {
22660+
"$ref": "#/definitions/CsmDeploymentStatus"
22661+
}
22662+
},
22663+
"nextLink": {
22664+
"description": "Link to next page of resources.",
22665+
"type": "string",
22666+
"readOnly": true
22667+
}
22668+
}
22669+
},
2234222670
"CsmPublishingCredentialsPoliciesEntity": {
2234322671
"description": "Publishing Credentials Policies parameters.",
2234422672
"type": "object",

‎specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/examples/GetSiteDeploymentStatus.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
4+
"resourceGroupName": "rg",
5+
"name": "testSite",
6+
"deploymentStatusId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
7+
"api-version": "2022-03-01"
8+
},
9+
"responses": {
10+
"200": {
11+
"headers": {},
12+
"body": {
13+
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
14+
"name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
15+
"type": "Microsoft.Web/sites/deploymentStatus",
16+
"properties": {
17+
"deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
18+
"status": "RuntimeSuccessful",
19+
"numberOfInstancesInProgress": 0,
20+
"numberOfInstancesSuccessful": 1,
21+
"numberOfInstancesFailed": 0,
22+
"failedInstancesLogs": [],
23+
"errors": null
24+
}
25+
}
26+
},
27+
"202": {
28+
"headers": {},
29+
"body": {
30+
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
31+
"name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
32+
"type": "Microsoft.Web/sites/deploymentStatus",
33+
"properties": {
34+
"deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
35+
"status": "RuntimeStarting",
36+
"numberOfInstancesInProgress": 1,
37+
"numberOfInstancesSuccessful": 0,
38+
"numberOfInstancesFailed": 0,
39+
"failedInstancesLogs": [],
40+
"errors": null
41+
}
42+
}
43+
}
44+
}
45+
}

0 commit comments

Comments
 (0)