Microsoft.Edge (stable:2025-08-01)

2025/09/02 • 10 updated methods

Jobs_ListByTarget (updated)
Description :  List Jobs by parent resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_ListByTarget",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "jobType",
                "Enum": {
                  "new": [
                    [
                      "deploy",
                      "A deployment job."
                    ],
                    [
                      "publish",
                      "A publish job."
                    ],
                    [
                      "staging",
                      "A staging job."
                    ],
                    [
                      "externalValidation",
                      "A validation job."
                    ]
                  ],
                  "old": [
                    [
                      "deploy",
                      "A deployment job."
                    ],
                    [
                      "staging",
                      "A staging job."
                    ],
                    [
                      "externalValidation",
                      "A validation job."
                    ]
                  ]
                }
              },
              {
                "jobParameter": [
                  {
                    "#name": "jobType",
                    "Enum": {
                      "new": [
                        [
                          "deploy",
                          "A deployment job."
                        ],
                        [
                          "publish",
                          "A publish job."
                        ],
                        [
                          "staging",
                          "A staging job."
                        ],
                        [
                          "externalValidation",
                          "A validation job."
                        ]
                      ],
                      "old": [
                        [
                          "deploy",
                          "A deployment job."
                        ],
                        [
                          "staging",
                          "A staging job."
                        ],
                        [
                          "externalValidation",
                          "A validation job."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "steps": {
                  "$properties": {
                    "statistics": [
                      {
                        "#name": "statisticsType",
                        "Enum": {
                          "new": [
                            [
                              "deploy",
                              "A deployment job."
                            ],
                            [
                              "publish",
                              "A publish job."
                            ],
                            [
                              "staging",
                              "A staging job."
                            ],
                            [
                              "externalValidation",
                              "A validation job."
                            ]
                          ],
                          "old": [
                            [
                              "deploy",
                              "A deployment job."
                            ],
                            [
                              "staging",
                              "A staging job."
                            ],
                            [
                              "externalValidation",
                              "A validation job."
                            ]
                          ]
                        }
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Edge/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Job items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
jobType:
{
Description: The type of job. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time of the job (ISO8601). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the job (ISO8601). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. ,
Enum:
{
NotStarted: The job or step is not started. ,
InProgress: The job or step is in progress. ,
Succeeded: The job or step succeeded. ,
Failed: The job or step failed. ,
}
,
Required: True ,
}
enum ,
jobParameter:
{
Description: Parameters for the job. ,
Required: False ,
}
{
jobType:
{
Description: Job type discriminator value ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: True ,
}
enum ,
}
,
correlationId:
{
Description: Correlation ID for tracking. ,
Required: False ,
}
string ,
steps:
{
Description: Steps and substatuses for the job. ,
Required: False ,
}
[
{
name:
{
Description: Name of the step ,
Required: True ,
}
string ,
status:
{
Description: Status of the step ,
Enum:
{
NotStarted: The job or step is not started. ,
InProgress: The job or step is in progress. ,
Succeeded: The job or step succeeded. ,
Failed: The job or step failed. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time of the step (ISO8601) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the step (ISO8601) ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Message for the step ,
Required: False ,
}
string ,
statistics:
{
Description: Statistics for the step ,
Required: False ,
}
{
statisticsType:
{
Description: Statistics type discriminator value ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: True ,
}
enum ,
}
,
steps:
{
Description: Nested substeps for this step ,
Required: False ,
}
[
string ,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
triggeredBy:
{
Description: The OID or identity that triggered the job. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_Get (updated)
Description :  Get a Job resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "jobType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          },
          {
            "jobParameter": [
              {
                "#name": "jobType",
                "Enum": {
                  "new": [
                    [
                      "deploy",
                      "A deployment job."
                    ],
                    [
                      "publish",
                      "A publish job."
                    ],
                    [
                      "staging",
                      "A staging job."
                    ],
                    [
                      "externalValidation",
                      "A validation job."
                    ]
                  ],
                  "old": [
                    [
                      "deploy",
                      "A deployment job."
                    ],
                    [
                      "staging",
                      "A staging job."
                    ],
                    [
                      "externalValidation",
                      "A validation job."
                    ]
                  ]
                }
              }
            ]
          },
          {
            "steps": {
              "$properties": {
                "statistics": [
                  {
                    "#name": "statisticsType",
                    "Enum": {
                      "new": [
                        [
                          "deploy",
                          "A deployment job."
                        ],
                        [
                          "publish",
                          "A publish job."
                        ],
                        [
                          "staging",
                          "A staging job."
                        ],
                        [
                          "externalValidation",
                          "A validation job."
                        ]
                      ],
                      "old": [
                        [
                          "deploy",
                          "A deployment job."
                        ],
                        [
                          "staging",
                          "A staging job."
                        ],
                        [
                          "externalValidation",
                          "A validation job."
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Edge/jobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
jobType:
{
Description: The type of job. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time of the job (ISO8601). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the job (ISO8601). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. ,
Enum:
{
NotStarted: The job or step is not started. ,
InProgress: The job or step is in progress. ,
Succeeded: The job or step succeeded. ,
Failed: The job or step failed. ,
}
,
Required: True ,
}
enum ,
jobParameter:
{
Description: Parameters for the job. ,
Required: False ,
}
{
jobType:
{
Description: Job type discriminator value ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: True ,
}
enum ,
}
,
correlationId:
{
Description: Correlation ID for tracking. ,
Required: False ,
}
string ,
steps:
{
Description: Steps and substatuses for the job. ,
Required: False ,
}
[
{
name:
{
Description: Name of the step ,
Required: True ,
}
string ,
status:
{
Description: Status of the step ,
Enum:
{
NotStarted: The job or step is not started. ,
InProgress: The job or step is in progress. ,
Succeeded: The job or step succeeded. ,
Failed: The job or step failed. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time of the step (ISO8601) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the step (ISO8601) ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Message for the step ,
Required: False ,
}
string ,
statistics:
{
Description: Statistics for the step ,
Required: False ,
}
{
statisticsType:
{
Description: Statistics type discriminator value ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: True ,
}
enum ,
}
,
steps:
{
Description: Nested substeps for this step ,
Required: False ,
}
[
string ,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
triggeredBy:
{
Description: The OID or identity that triggered the job. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Targets_PublishSolutionVersion (updated)
Description :  Post request to publish
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_PublishSolutionVersion",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/publishSolutionVersion
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
solutionVersionId:
{
Description: Solution Version ARM Id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Targets_ReviewSolutionVersion (updated)
Description :  Post request to review configuration
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_ReviewSolutionVersion",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/reviewSolutionVersion
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version ARM Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependencies ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: False ,
}
string ,
solutionTemplateId:
{
Description: Solution Template Id ,
Required: False ,
}
string ,
solutionTemplateVersion:
{
Description: Solution Template Version ,
Required: False ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
targetId:
{
Description: Target Id ,
Required: False ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionVersions_ListBySolution (updated)
Description :  List Solution Version Resources
Reference :  Link ¶

⚶ Changes

{
  "#id": "SolutionVersions_ListBySolution",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "actionType",
                "Enum": {
                  "new": [
                    [
                      "deploy",
                      "A deployment job."
                    ],
                    [
                      "publish",
                      "A publish job."
                    ],
                    [
                      "staging",
                      "A staging job."
                    ],
                    [
                      "externalValidation",
                      "A validation job."
                    ]
                  ],
                  "old": [
                    [
                      "deploy",
                      "A deployment job."
                    ],
                    [
                      "staging",
                      "A staging job."
                    ],
                    [
                      "externalValidation",
                      "A validation job."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
solutionName:
{
Description: Name of the solution ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionVersions_Get (updated)
Description :  Get a Solution Version Resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "SolutionVersions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/versions/{solutionVersionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
solutionName:
{
Description: Name of the solution ,
Required: True ,
}
string ,
solutionVersionName:
{
Description: Name of the solution version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionVersions_CreateOrUpdate (updated)
Description :  Create or update a Solution Version Resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "SolutionVersions_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/versions/{solutionVersionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
solutionName:
{
Description: Name of the solution ,
Required: True ,
}
string ,
solutionVersionName:
{
Description: Name of the solution version ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Solution Version Resource. It has the resolved configuration along with edge specification. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionVersions_Update (updated)
Description :  Update a Solution Version Resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "SolutionVersions_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/versions/{solutionVersionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
solutionName:
{
Description: Name of the solution ,
Required: True ,
}
string ,
solutionVersionName:
{
Description: Name of the solution version ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
specification:
{
Description: App components spec ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Targets_UnstageSolutionVersion (updated)
Description :  Post request to unstage solution version
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_UnstageSolutionVersion",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/unstageSolutionVersion
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
solutionVersionId:
{
Description: Solution Version ARM Id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Targets_UpdateExternalValidationStatus (updated)
Description :  Post request to update external validation status
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_UpdateExternalValidationStatus",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actionType",
            "Enum": {
              "new": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "publish",
                  "A publish job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ],
              "old": [
                [
                  "deploy",
                  "A deployment job."
                ],
                [
                  "staging",
                  "A staging job."
                ],
                [
                  "externalValidation",
                  "A validation job."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/updateExternalValidationStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
externalValidationId:
{
Description: External validation id ,
Required: True ,
}
string ,
validationStatus:
{
Description: Validation Status of external validation ,
Enum:
{
Valid: Solution Instance is valid ,
Invalid: Solution Instance is invalid ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: False ,
}
string ,
revision:
{
Description: Revision number of resolved config for this solution version ,
Format: int32 ,
Required: False ,
}
integer ,
targetDisplayName:
{
Description: Name of applicable target's display name ,
Required: False ,
}
string ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
targetLevelConfiguration:
{
Description: Configuration on the line level across all solution template versions ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
reviewId:
{
Description: Review id of resolved config for this solution version ,
Required: False ,
}
string ,
externalValidationId:
{
Description: External validation id ,
Required: False ,
}
string ,
state:
{
Description: State of solution instance ,
Enum:
{
InReview: Solution Instance is in review ,
UpgradeInReview: Solution Instance upgrade is in review ,
ReadyToDeploy: Solution Instance is ready to deploy ,
ReadyToUpgrade: Solution Instance is ready to upgrade ,
Deploying: Solution Instance is deploying ,
Deployed: Solution Instance is deployed ,
Failed: Solution Instance failed to deploy ,
Undeployed: Solution Instance is undeployed ,
PendingExternalValidation: Solution Instance is pending external validation ,
ExternalValidationFailed: Solution Instance failed external validation ,
Staging: Solution Instance is staging the images ,
NotApplicable: State is not applicable ,
}
,
Required: False ,
}
enum ,
currentStage:
{
Description: Current Stage of revision ,
Required: False ,
}
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
stages:
{
Description: Stages of revision ,
Required: False ,
}
[
{
displayState:
{
Description: Display State ,
Required: True ,
}
string ,
stage:
{
Description: Stage name ,
Enum:
{
Configuration: Configuration stage ,
Publish: Publish stage ,
Deployment: Deployment stage ,
Uninstallation: Uninstallation stage ,
ExternalValidation: External Validation stage ,
Staging: Staging stage ,
Unstaging: Unstaging stage ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Stage status ,
Enum:
{
Pending: Pending state [Non-Terminal] ,
InProgress: InProgress state [Non-Terminal] ,
Completed: Completed state [Terminal] ,
Failed: Failed state [Terminal] ,
None: None state [Terminal] ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Stage end time ,
Format: date-time ,
Required: False ,
}
string ,
childStages:
{
Description: Child stages which represents more granular level stage status if any ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
solutionInstanceName:
{
Description: Solution instance name ,
Required: False ,
}
string ,
solutionDependencies:
{
Description: Solution Dependency Context ,
Required: False ,
}
[
{
solutionVersionId:
{
Description: Solution Version Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
Required: False ,
}
string ,
solutionTemplateVersionId:
{
Description: Solution Template Version Id ,
Required: True ,
}
string ,
targetId:
{
Description: Target Id ,
Required: True ,
}
string ,
dependencies:
{
Description: Solution dependencies ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
errorDetails:
{
Description: Error Details if any failure is there ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
latestActionTrackingUri:
{
Description: The URI for tracking the latest action performed on this solution version. ,
Required: False ,
}
string ,
lastestActionTriggeredBy:
{
Description: Object Id of user who triggered the latest action on this solution version. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment job. ,
publish: A publish job. ,
staging: A staging job. ,
externalValidation: A validation job. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Initialized: Resource Provisioning is initialized ,
InProgress: Resource Provisioning is in progress ,
Deleting: Resource Provisioning is deleting ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}