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

2025/06/25 • 132 new methods

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

⚼ 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. ,
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. ,
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. ,
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 (new)
Description :  Get a Job resource
Reference :  Link ¶

⚼ 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. ,
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. ,
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. ,
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 ,
}
,
]
,
}
,
}
SchemaReferences_ListByResourceGroup (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Edge/schemaReferences
{
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 SchemaReference items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
schemaId:
{
Description: Schema Id of schema reference ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SchemaReferences_Get (new)
Description :  Get a Schema Reference Resource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Edge/schemaReferences/{schemaReferenceName}
{
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 ,
schemaReferenceName:
{
Description: The name of the SchemaReference ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
schemaId:
{
Description: Schema Id of schema reference ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
ConfigTemplates_ListBySubscription (new)
Description :  List by subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Edge/configTemplates
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ConfigTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of config template ,
Required: True ,
}
string ,
latestVersion:
{
Description: Latest config template version ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Contexts_ListBySubscription (new)
Description :  List by subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Edge/contexts
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Context items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: True ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: True ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Diagnostics_ListBySubscription (new)
Description :  Lists Diagnostics resources within an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Edge/diagnostics
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Diagnostic items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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 ,
}
,
]
,
}
,
}
Schemas_ListBySubscription (new)
Description :  List by subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Edge/schemas
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Schema items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplates_ListBySubscription (new)
Description :  List by subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Edge/solutionTemplates
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of Solution template ,
Required: True ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
latestVersion:
{
Description: Latest solution template version ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Targets_ListBySubscription (new)
Description :  List by subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Edge/targets
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Target items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: True ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: True ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: True ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: True ,
}
string ,
status:
{
Description: Status of target ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
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 ,
}
,
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 ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ConfigTemplates_ListByResourceGroup (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ConfigTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of config template ,
Required: True ,
}
string ,
latestVersion:
{
Description: Latest config template version ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
ConfigTemplates_Get (new)
Description :  Get a Config Template Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}
{
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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of config template ,
Required: True ,
}
string ,
latestVersion:
{
Description: Latest config template version ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
ConfigTemplates_CreateOrUpdate (new)
Description :  Create or update a Config Template Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}
{
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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of config template ,
Required: True ,
}
string ,
latestVersion:
{
Description: Latest config template version ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
{
description:
{
Description: Description of config template ,
Required: True ,
}
string ,
latestVersion:
{
Description: Latest config template version ,
Required: False ,
}
string ,
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 ,
}
,
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: Config Template Resource. Contains configuration expressions using the predefined expression language. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of config template ,
Required: True ,
}
string ,
latestVersion:
{
Description: Latest config template version ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
ConfigTemplates_Update (new)
Description :  update a Config Template Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}
{
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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of config template ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of config template ,
Required: True ,
}
string ,
latestVersion:
{
Description: Latest config template version ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
ConfigTemplates_Delete (new)
Description :  Delete a Config Template Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}
{
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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ConfigTemplates_CreateVersion (new)
Description :  Create or update a Config Template Version Resource with the specified UpdateType
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}/createVersion
{
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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
updateType:
{
Description: Update type ,
Enum:
{
Major: Major version ,
Minor: Minor version ,
Patch: Patch version ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version to create ,
Required: False ,
}
string ,
configTemplateVersion:
{
Description: Config Template Version ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurations:
{
Description: Configuration values ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
{
configurations:
{
Description: Configuration values ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
ConfigTemplates_RemoveVersion (new)
Description :  Remove Config Template Version Resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}/removeVersion
{
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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
version:
{
Description: Version of the Resource ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Status for remove version response ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
ConfigTemplateVersions_ListByConfigTemplate (new)
Description :  List Config Template Version Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}/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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ConfigTemplateVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurations:
{
Description: Configuration values ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
ConfigTemplateVersions_Get (new)
Description :  Get a Config Template Version Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configTemplates/{configTemplateName}/versions/{configTemplateVersionName}
{
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 ,
configTemplateName:
{
Description: The name of the ConfigTemplate ,
Required: True ,
}
string ,
configTemplateVersionName:
{
Description: The name of the ConfigTemplateVersion ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurations:
{
Description: Configuration values ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Contexts_ListByResourceGroup (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Context items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: True ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: True ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Contexts_Get (new)
Description :  Get Context Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: True ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: True ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Contexts_CreateOrUpdate (new)
Description :  Create or update Context Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: True ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: True ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: True ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: True ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}

⚐ 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: Context Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: True ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: True ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Contexts_Update (new)
Description :  update an Context Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: False ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: False ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
capabilities:
{
Description: List of Capabilities ,
Required: True ,
}
[
{
name:
{
Description: Name of Capability ,
Required: True ,
}
string ,
description:
{
Description: Description of Capability ,
Required: True ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hierarchies:
{
Description: List of Hierarchies ,
Required: True ,
}
[
{
name:
{
Description: Name of Hierarchy ,
Required: True ,
}
string ,
description:
{
Description: Description of Hierarchy ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Contexts_Delete (new)
Description :  Delete Context Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
SiteReferences_ListByContext (new)
Description :  List Site Reference Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/siteReferences
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SiteReference items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteId:
{
Description: Azure Resource ID for Site ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
SiteReferences_Get (new)
Description :  Get Site Reference Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/siteReferences/{siteReferenceName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
siteReferenceName:
{
Description: The name of the SiteReference ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteId:
{
Description: Azure Resource ID for Site ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
SiteReferences_CreateOrUpdate (new)
Description :  Get Site Reference Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/siteReferences/{siteReferenceName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
siteReferenceName:
{
Description: The name of the SiteReference ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteId:
{
Description: Azure Resource ID for Site ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteId:
{
Description: Azure Resource ID for Site ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State ,
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 ,
}
,
}

⚐ 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: Site Reference Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteId:
{
Description: Azure Resource ID for Site ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
SiteReferences_Update (new)
Description :  Get Site Reference Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/siteReferences/{siteReferenceName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
siteReferenceName:
{
Description: The name of the SiteReference ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteId:
{
Description: Azure Resource ID for Site ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteId:
{
Description: Azure Resource ID for Site ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
SiteReferences_Delete (new)
Description :  Get Site Reference Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/siteReferences/{siteReferenceName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
siteReferenceName:
{
Description: The name of the SiteReference ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Workflows_ListByContext (new)
Description :  List Workflow resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Workflow items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowTemplateId:
{
Description: Workflow template Id ,
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
}
Workflows_Get (new)
Description :  Get a Workflow resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowTemplateId:
{
Description: Workflow template Id ,
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
}
Workflows_CreateOrUpdate (new)
Description :  Create or update a Workflow resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowTemplateId:
{
Description: Workflow template Id ,
Required: False ,
}
string ,
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 ,
}
{
workflowTemplateId:
{
Description: Workflow template Id ,
Required: False ,
}
string ,
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: Workflow Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowTemplateId:
{
Description: Workflow template Id ,
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
}
Workflows_Update (new)
Description :  update a Workflow resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowTemplateId:
{
Description: Workflow template Id ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowTemplateId:
{
Description: Workflow template Id ,
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
}
Workflows_Delete (new)
Description :  Delete a Workflow resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
WorkflowVersions_ListByWorkflow (new)
Description :  List Workflow Version Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkflowVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
revision:
{
Description: Revision number of resolved config for this workflow version ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
stageSpec:
{
Description: A list of stage specs ,
Required: True ,
}
[
{
name:
{
Description: Name of Stage ,
Required: True ,
}
string ,
specification:
{
Description: Stage specification ,
Required: False ,
}
object ,
tasks:
{
Description: List of tasks in the stage ,
Required: False ,
}
[
{
name:
{
Description: Name of Task ,
Required: True ,
}
string ,
targetId:
{
Description: Target ARM id ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: Task specification ,
Required: True ,
}
object ,
}
,
]
,
taskOption:
{
Description: Task option for the stage ,
Required: False ,
}
{
concurrency:
{
Description: Parallel worker numbers of the tasks ,
Format: int32 ,
Required: False ,
}
integer ,
errorAction:
{
Description: Error action for the tasks ,
Required: False ,
}
{
mode:
{
Description: Error action mode ,
Enum:
{
stopOnAnyFailure: Stop on any failure ,
stopOnNFailures: Stop after N cumulative failures ,
silentlyContinue: Continue silently despite errors ,
}
,
Required: False ,
}
enum ,
maxToleratedFailures:
{
Description: Max tolerated failures ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
reviewId:
{
Description: Review id of resolved config for this workflow version ,
Required: False ,
}
string ,
state:
{
Description: State of workflow version ,
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 ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
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 ,
}
,
]
,
}
,
}
WorkflowVersions_Get (new)
Description :  Get a Workflow Version Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
revision:
{
Description: Revision number of resolved config for this workflow version ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
stageSpec:
{
Description: A list of stage specs ,
Required: True ,
}
[
{
name:
{
Description: Name of Stage ,
Required: True ,
}
string ,
specification:
{
Description: Stage specification ,
Required: False ,
}
object ,
tasks:
{
Description: List of tasks in the stage ,
Required: False ,
}
[
{
name:
{
Description: Name of Task ,
Required: True ,
}
string ,
targetId:
{
Description: Target ARM id ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: Task specification ,
Required: True ,
}
object ,
}
,
]
,
taskOption:
{
Description: Task option for the stage ,
Required: False ,
}
{
concurrency:
{
Description: Parallel worker numbers of the tasks ,
Format: int32 ,
Required: False ,
}
integer ,
errorAction:
{
Description: Error action for the tasks ,
Required: False ,
}
{
mode:
{
Description: Error action mode ,
Enum:
{
stopOnAnyFailure: Stop on any failure ,
stopOnNFailures: Stop after N cumulative failures ,
silentlyContinue: Continue silently despite errors ,
}
,
Required: False ,
}
enum ,
maxToleratedFailures:
{
Description: Max tolerated failures ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
reviewId:
{
Description: Review id of resolved config for this workflow version ,
Required: False ,
}
string ,
state:
{
Description: State of workflow version ,
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 ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
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 ,
}
,
]
,
}
,
}
WorkflowVersions_CreateOrUpdate (new)
Description :  Create or update a Workflow Version Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
revision:
{
Description: Revision number of resolved config for this workflow version ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
stageSpec:
{
Description: A list of stage specs ,
Required: True ,
}
[
{
name:
{
Description: Name of Stage ,
Required: True ,
}
string ,
specification:
{
Description: Stage specification ,
Required: False ,
}
object ,
tasks:
{
Description: List of tasks in the stage ,
Required: False ,
}
[
{
name:
{
Description: Name of Task ,
Required: True ,
}
string ,
targetId:
{
Description: Target ARM id ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: Task specification ,
Required: True ,
}
object ,
}
,
]
,
taskOption:
{
Description: Task option for the stage ,
Required: False ,
}
{
concurrency:
{
Description: Parallel worker numbers of the tasks ,
Format: int32 ,
Required: False ,
}
integer ,
errorAction:
{
Description: Error action for the tasks ,
Required: False ,
}
{
mode:
{
Description: Error action mode ,
Enum:
{
stopOnAnyFailure: Stop on any failure ,
stopOnNFailures: Stop after N cumulative failures ,
silentlyContinue: Continue silently despite errors ,
}
,
Required: False ,
}
enum ,
maxToleratedFailures:
{
Description: Max tolerated failures ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
reviewId:
{
Description: Review id of resolved config for this workflow version ,
Required: False ,
}
string ,
state:
{
Description: State of workflow version ,
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 ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
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 ,
}
{
revision:
{
Description: Revision number of resolved config for this workflow version ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
stageSpec:
{
Description: A list of stage specs ,
Required: True ,
}
[
{
name:
{
Description: Name of Stage ,
Required: True ,
}
string ,
specification:
{
Description: Stage specification ,
Required: False ,
}
object ,
tasks:
{
Description: List of tasks in the stage ,
Required: False ,
}
[
{
name:
{
Description: Name of Task ,
Required: True ,
}
string ,
targetId:
{
Description: Target ARM id ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: Task specification ,
Required: True ,
}
object ,
}
,
]
,
taskOption:
{
Description: Task option for the stage ,
Required: False ,
}
{
concurrency:
{
Description: Parallel worker numbers of the tasks ,
Format: int32 ,
Required: False ,
}
integer ,
errorAction:
{
Description: Error action for the tasks ,
Required: False ,
}
{
mode:
{
Description: Error action mode ,
Enum:
{
stopOnAnyFailure: Stop on any failure ,
stopOnNFailures: Stop after N cumulative failures ,
silentlyContinue: Continue silently despite errors ,
}
,
Required: False ,
}
enum ,
maxToleratedFailures:
{
Description: Max tolerated failures ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
reviewId:
{
Description: Review id of resolved config for this workflow version ,
Required: False ,
}
string ,
state:
{
Description: State of workflow version ,
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 ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
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: Workflow Version Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
revision:
{
Description: Revision number of resolved config for this workflow version ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
stageSpec:
{
Description: A list of stage specs ,
Required: True ,
}
[
{
name:
{
Description: Name of Stage ,
Required: True ,
}
string ,
specification:
{
Description: Stage specification ,
Required: False ,
}
object ,
tasks:
{
Description: List of tasks in the stage ,
Required: False ,
}
[
{
name:
{
Description: Name of Task ,
Required: True ,
}
string ,
targetId:
{
Description: Target ARM id ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: Task specification ,
Required: True ,
}
object ,
}
,
]
,
taskOption:
{
Description: Task option for the stage ,
Required: False ,
}
{
concurrency:
{
Description: Parallel worker numbers of the tasks ,
Format: int32 ,
Required: False ,
}
integer ,
errorAction:
{
Description: Error action for the tasks ,
Required: False ,
}
{
mode:
{
Description: Error action mode ,
Enum:
{
stopOnAnyFailure: Stop on any failure ,
stopOnNFailures: Stop after N cumulative failures ,
silentlyContinue: Continue silently despite errors ,
}
,
Required: False ,
}
enum ,
maxToleratedFailures:
{
Description: Max tolerated failures ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
reviewId:
{
Description: Review id of resolved config for this workflow version ,
Required: False ,
}
string ,
state:
{
Description: State of workflow version ,
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 ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
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 ,
}
,
]
,
}
,
}
WorkflowVersions_Update (new)
Description :  update an WorkflowVersion Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
stageSpec:
{
Description: A list of stage specs ,
Required: False ,
}
[
{
name:
{
Description: Name of Stage ,
Required: True ,
}
string ,
specification:
{
Description: Stage specification ,
Required: False ,
}
object ,
tasks:
{
Description: List of tasks in the stage ,
Required: False ,
}
[
{
name:
{
Description: Name of Task ,
Required: True ,
}
string ,
targetId:
{
Description: Target ARM id ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: Task specification ,
Required: True ,
}
object ,
}
,
]
,
taskOption:
{
Description: Task option for the stage ,
Required: False ,
}
{
concurrency:
{
Description: Parallel worker numbers of the tasks ,
Format: int32 ,
Required: False ,
}
integer ,
errorAction:
{
Description: Error action for the tasks ,
Required: False ,
}
{
mode:
{
Description: Error action mode ,
Enum:
{
stopOnAnyFailure: Stop on any failure ,
stopOnNFailures: Stop after N cumulative failures ,
silentlyContinue: Continue silently despite errors ,
}
,
Required: False ,
}
enum ,
maxToleratedFailures:
{
Description: Max tolerated failures ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
revision:
{
Description: Revision number of resolved config for this workflow version ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: Resolved configuration values ,
Required: False ,
}
string ,
stageSpec:
{
Description: A list of stage specs ,
Required: True ,
}
[
{
name:
{
Description: Name of Stage ,
Required: True ,
}
string ,
specification:
{
Description: Stage specification ,
Required: False ,
}
object ,
tasks:
{
Description: List of tasks in the stage ,
Required: False ,
}
[
{
name:
{
Description: Name of Task ,
Required: True ,
}
string ,
targetId:
{
Description: Target ARM id ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: Task specification ,
Required: True ,
}
object ,
}
,
]
,
taskOption:
{
Description: Task option for the stage ,
Required: False ,
}
{
concurrency:
{
Description: Parallel worker numbers of the tasks ,
Format: int32 ,
Required: False ,
}
integer ,
errorAction:
{
Description: Error action for the tasks ,
Required: False ,
}
{
mode:
{
Description: Error action mode ,
Enum:
{
stopOnAnyFailure: Stop on any failure ,
stopOnNFailures: Stop after N cumulative failures ,
silentlyContinue: Continue silently despite errors ,
}
,
Required: False ,
}
enum ,
maxToleratedFailures:
{
Description: Max tolerated failures ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
reviewId:
{
Description: Review id of resolved config for this workflow version ,
Required: False ,
}
string ,
state:
{
Description: State of workflow version ,
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 ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
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 ,
}
,
]
,
}
,
}
WorkflowVersions_Delete (new)
Description :  Delete a Workflow Version Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Executions_ListByWorkflowVersion (new)
Description :  List Execution Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}/executions
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Execution items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowVersionId:
{
Description: Workflow version of execution ,
Required: True ,
}
string ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
status:
{
Description: Status of Execution ,
Required: False ,
}
{
updateTime:
{
Description: The lastModified timestamp of the Status ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: status details ,
Required: False ,
}
string ,
stageHistory:
{
Description: target resource statuses ,
Required: False ,
}
[
{
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: Status message ,
Required: False ,
}
string ,
stage:
{
Description: Current stage ,
Required: False ,
}
string ,
nextstage:
{
Description: Next stage ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message ,
Required: False ,
}
string ,
isActive:
{
Description: whether this stage is active or inactive ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
inputs:
{
Description: The inputs of the StageHistory, Inputs holds a key-value map of user-defined parameters for the initial stage ,
Required: False ,
}
object ,
outputs:
{
Description: The outputs of the StageHistory, it is different as the different input stages. ,
Required: False ,
}
object ,
}
,
]
,
}
,
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 ,
}
,
]
,
}
,
}
Executions_Get (new)
Description :  Get Execution Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}/executions/{executionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
executionName:
{
Description: The name of the Execution. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowVersionId:
{
Description: Workflow version of execution ,
Required: True ,
}
string ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
status:
{
Description: Status of Execution ,
Required: False ,
}
{
updateTime:
{
Description: The lastModified timestamp of the Status ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: status details ,
Required: False ,
}
string ,
stageHistory:
{
Description: target resource statuses ,
Required: False ,
}
[
{
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: Status message ,
Required: False ,
}
string ,
stage:
{
Description: Current stage ,
Required: False ,
}
string ,
nextstage:
{
Description: Next stage ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message ,
Required: False ,
}
string ,
isActive:
{
Description: whether this stage is active or inactive ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
inputs:
{
Description: The inputs of the StageHistory, Inputs holds a key-value map of user-defined parameters for the initial stage ,
Required: False ,
}
object ,
outputs:
{
Description: The outputs of the StageHistory, it is different as the different input stages. ,
Required: False ,
}
object ,
}
,
]
,
}
,
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 ,
}
,
]
,
}
,
}
Executions_CreateOrUpdate (new)
Description :  Create or update Execution Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}/executions/{executionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
executionName:
{
Description: The name of the Execution. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowVersionId:
{
Description: Workflow version of execution ,
Required: True ,
}
string ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
status:
{
Description: Status of Execution ,
Required: False ,
}
{
updateTime:
{
Description: The lastModified timestamp of the Status ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: status details ,
Required: False ,
}
string ,
stageHistory:
{
Description: target resource statuses ,
Required: False ,
}
[
{
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: Status message ,
Required: False ,
}
string ,
stage:
{
Description: Current stage ,
Required: False ,
}
string ,
nextstage:
{
Description: Next stage ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message ,
Required: False ,
}
string ,
isActive:
{
Description: whether this stage is active or inactive ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
inputs:
{
Description: The inputs of the StageHistory, Inputs holds a key-value map of user-defined parameters for the initial stage ,
Required: False ,
}
object ,
outputs:
{
Description: The outputs of the StageHistory, it is different as the different input stages. ,
Required: False ,
}
object ,
}
,
]
,
}
,
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 ,
}
{
workflowVersionId:
{
Description: Workflow version of execution ,
Required: True ,
}
string ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
status:
{
Description: Status of Execution ,
Required: False ,
}
{
updateTime:
{
Description: The lastModified timestamp of the Status ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: status details ,
Required: False ,
}
string ,
stageHistory:
{
Description: target resource statuses ,
Required: False ,
}
[
{
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: Status message ,
Required: False ,
}
string ,
stage:
{
Description: Current stage ,
Required: False ,
}
string ,
nextstage:
{
Description: Next stage ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message ,
Required: False ,
}
string ,
isActive:
{
Description: whether this stage is active or inactive ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
inputs:
{
Description: The inputs of the StageHistory, Inputs holds a key-value map of user-defined parameters for the initial stage ,
Required: False ,
}
object ,
outputs:
{
Description: The outputs of the StageHistory, it is different as the different input stages. ,
Required: False ,
}
object ,
}
,
]
,
}
,
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: Execution Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowVersionId:
{
Description: Workflow version of execution ,
Required: True ,
}
string ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
status:
{
Description: Status of Execution ,
Required: False ,
}
{
updateTime:
{
Description: The lastModified timestamp of the Status ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: status details ,
Required: False ,
}
string ,
stageHistory:
{
Description: target resource statuses ,
Required: False ,
}
[
{
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: Status message ,
Required: False ,
}
string ,
stage:
{
Description: Current stage ,
Required: False ,
}
string ,
nextstage:
{
Description: Next stage ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message ,
Required: False ,
}
string ,
isActive:
{
Description: whether this stage is active or inactive ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
inputs:
{
Description: The inputs of the StageHistory, Inputs holds a key-value map of user-defined parameters for the initial stage ,
Required: False ,
}
object ,
outputs:
{
Description: The outputs of the StageHistory, it is different as the different input stages. ,
Required: False ,
}
object ,
}
,
]
,
}
,
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 ,
}
,
]
,
}
,
}
Executions_Update (new)
Description :  update an Execution Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}/executions/{executionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
executionName:
{
Description: The name of the Execution. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowVersionId:
{
Description: Workflow version of execution ,
Required: False ,
}
string ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workflowVersionId:
{
Description: Workflow version of execution ,
Required: True ,
}
string ,
specification:
{
Description: Execution specification ,
Required: False ,
}
object ,
status:
{
Description: Status of Execution ,
Required: False ,
}
{
updateTime:
{
Description: The lastModified timestamp of the Status ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: status details ,
Required: False ,
}
string ,
stageHistory:
{
Description: target resource statuses ,
Required: False ,
}
[
{
status:
{
Description: Deployment status ,
Format: int32 ,
Required: False ,
}
integer ,
statusMessage:
{
Description: Status message ,
Required: False ,
}
string ,
stage:
{
Description: Current stage ,
Required: False ,
}
string ,
nextstage:
{
Description: Next stage ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message ,
Required: False ,
}
string ,
isActive:
{
Description: whether this stage is active or inactive ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
inputs:
{
Description: The inputs of the StageHistory, Inputs holds a key-value map of user-defined parameters for the initial stage ,
Required: False ,
}
object ,
outputs:
{
Description: The outputs of the StageHistory, it is different as the different input stages. ,
Required: False ,
}
object ,
}
,
]
,
}
,
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 ,
}
,
]
,
}
,
}
Executions_Delete (new)
Description :  Delete Execution Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/contexts/{contextName}/workflows/{workflowName}/versions/{versionName}/executions/{executionName}
{
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 ,
contextName:
{
Description: The name of the Context. ,
Required: True ,
}
string ,
workflowName:
{
Description: Name of the workflow ,
Required: True ,
}
string ,
versionName:
{
Description: The name of the workflowVersion. ,
Required: True ,
}
string ,
executionName:
{
Description: The name of the Execution. ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Diagnostics_ListByResourceGroup (new)
Description :  Returns a collection of Diagnostic resources within the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/diagnostics
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Diagnostic items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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 ,
}
,
]
,
}
,
}
Diagnostics_Get (new)
Description :  Returns details of specified Diagnostic resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/diagnostics/{diagnosticName}
{
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 ,
diagnosticName:
{
Description: Name of Diagnostic. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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 ,
}
,
]
,
}
,
}
Diagnostics_CreateOrUpdate (new)
Description :  Creates new or updates existing Diagnostic resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/diagnostics/{diagnosticName}
{
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 ,
diagnosticName:
{
Description: Name of Diagnostic. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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 ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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: A Diagnostic resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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 ,
}
,
]
,
}
,
}
Diagnostics_Update (new)
Description :  Updates existing Diagnostic resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/diagnostics/{diagnosticName}
{
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 ,
diagnosticName:
{
Description: Name of Diagnostic. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
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 ,
}
,
]
,
}
,
}
Diagnostics_Delete (new)
Description :  Deletes specified Diagnostic resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/diagnostics/{diagnosticName}
{
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 ,
diagnosticName:
{
Description: Name of Diagnostic. ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Schemas_ListByResourceGroup (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Schema items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Schemas_Get (new)
Description :  Get a Schema Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Schemas_CreateOrUpdate (new)
Description :  Create or update a Schema Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
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: Schema Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Schemas_Update (new)
Description :  update a Schema Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of schema ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
Schemas_Delete (new)
Description :  Delete a Schema Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Schemas_CreateVersion (new)
Description :  Create a Schema Version Resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/createVersion
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
updateType:
{
Description: Update type ,
Enum:
{
Major: Major version ,
Minor: Minor version ,
Patch: Patch version ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version to create ,
Required: False ,
}
string ,
schemaVersion:
{
Description: Schema Version ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemas_ListBySchema (new)
Description :  List by Schema
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DynamicSchema items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationType:
{
Description: Type of configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
configurationModel:
{
Description: Type of configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemas_Get (new)
Description :  Get a DynamicSchema Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationType:
{
Description: Type of configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
configurationModel:
{
Description: Type of configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemas_CreateOrUpdate (new)
Description :  Create or update a DynamicSchema Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationType:
{
Description: Type of configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
configurationModel:
{
Description: Type of configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
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 ,
}
{
configurationType:
{
Description: Type of configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
configurationModel:
{
Description: Type of configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
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: DynamicSchema Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationType:
{
Description: Type of configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
configurationModel:
{
Description: Type of configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemas_Update (new)
Description :  update a DynamicSchema Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationType:
{
Description: Type of configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
configurationModel:
{
Description: Type of configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationType:
{
Description: Type of configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
configurationModel:
{
Description: Type of configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemas_Delete (new)
Description :  Delete a DynamicSchema Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicSchemaVersions_ListByDynamicSchema (new)
Description :  List by Dynamic Schema
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}/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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DynamicSchemaVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemaVersions_Get (new)
Description :  Get a Dynamic Schema Version Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemaVersions_CreateOrUpdate (new)
Description :  Create or update a Dynamic Schema Version Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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: Dynamic Schema Version Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemaVersions_Update (new)
Description :  update a Dynamic Schema Version Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
DynamicSchemaVersions_Delete (new)
Description :  Delete a Dynamic Schema Version Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/dynamicSchemas/{dynamicSchemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
dynamicSchemaName:
{
Description: The name of the DynamicSchema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Schemas_RemoveVersion (new)
Description :  Remove Schema Version Resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/removeVersion
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
version:
{
Description: Version of the Resource ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Status for remove version response ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
SchemaVersions_ListBySchema (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SchemaVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SchemaVersions_Get (new)
Description :  Get a Schema Version Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SchemaVersions_CreateOrUpdate (new)
Description :  Create or update a Schema Version Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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: Schema Version Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SchemaVersions_Update (new)
Description :  update a Schema Version Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
value:
{
Description: Value of schema version ,
Required: True ,
}
string ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SchemaVersions_Delete (new)
Description :  Delete a Schema Version Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/schemas/{schemaName}/versions/{schemaVersionName}
{
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 ,
schemaName:
{
Description: The name of the Schema ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: The name of the SchemaVersion ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
SolutionTemplates_ListByResourceGroup (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of Solution template ,
Required: True ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
latestVersion:
{
Description: Latest solution template version ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplates_Get (new)
Description :  Get a Solution Template Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of Solution template ,
Required: True ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
latestVersion:
{
Description: Latest solution template version ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplates_CreateOrUpdate (new)
Description :  Create or update a Solution Template Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of Solution template ,
Required: True ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
latestVersion:
{
Description: Latest solution template version ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
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 ,
}
,
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 ,
}
{
description:
{
Description: Description of Solution template ,
Required: True ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
latestVersion:
{
Description: Latest solution template version ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
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 ,
}
,
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 Template Resource. Contains capabilities and operations for creating versions. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of Solution template ,
Required: True ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
latestVersion:
{
Description: Latest solution template version ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplates_Update (new)
Description :  update a Solution Template Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of Solution template ,
Required: False ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of Solution template ,
Required: True ,
}
string ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
latestVersion:
{
Description: Latest solution template version ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
enableExternalValidation:
{
Description: Flag to enable external validation ,
Required: False ,
}
boolean ,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplates_Delete (new)
Description :  Delete a Solution Template Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
SolutionTemplates_CreateVersion (new)
Description :  Create a Solution Template Version Resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}/createVersion
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
updateType:
{
Description: Update type ,
Enum:
{
Major: Major version ,
Minor: Minor version ,
Patch: Patch version ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version to create ,
Required: False ,
}
string ,
solutionTemplateVersion:
{
Description: Solution Template Version ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurations:
{
Description: Config expressions for this solution version ,
Required: True ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
orchestratorType:
{
Description: Orchestrator type ,
Enum:
{
TO: Default type ,
}
,
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 ,
}
,
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 ,
}
{
configurations:
{
Description: Config expressions for this solution version ,
Required: True ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
orchestratorType:
{
Description: Orchestrator type ,
Enum:
{
TO: Default type ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplates_RemoveVersion (new)
Description :  Remove Solution Template Version Resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}/removeVersion
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
version:
{
Description: Version of the Resource ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
SolutionTemplateVersions_ListBySolutionTemplate (new)
Description :  List Solution Template Version Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}/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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionTemplateVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurations:
{
Description: Config expressions for this solution version ,
Required: True ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
orchestratorType:
{
Description: Orchestrator type ,
Enum:
{
TO: Default type ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplateVersions_Get (new)
Description :  Get a Solution Template Version Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}/versions/{solutionTemplateVersionName}
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
solutionTemplateVersionName:
{
Description: The name of the SolutionTemplateVersion ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurations:
{
Description: Config expressions for this solution version ,
Required: True ,
}
string ,
specification:
{
Description: App components spec ,
Required: True ,
}
object ,
orchestratorType:
{
Description: Orchestrator type ,
Enum:
{
TO: Default type ,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
SolutionTemplateVersions_BulkDeploySolution (new)
Description :  Post request for bulk deploy
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}/versions/{solutionTemplateVersionName}/bulkDeploySolution
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
solutionTemplateVersionName:
{
Description: The name of the SolutionTemplateVersion ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
targets:
{
Description: Targets to which solution needs to be deployed ,
Required: True ,
}
[
{
solutionVersionId:
{
Description: ArmId of Target Solution Version ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
SolutionTemplateVersions_BulkPublishSolution (new)
Description :  Post request for bulk publish
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/solutionTemplates/{solutionTemplateName}/versions/{solutionTemplateVersionName}/bulkPublishSolution
{
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 ,
solutionTemplateName:
{
Description: The name of the SolutionTemplate ,
Required: True ,
}
string ,
solutionTemplateVersionName:
{
Description: The name of the SolutionTemplateVersion ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
targets:
{
Description: Targets to which solution needs to be published ,
Required: True ,
}
[
{
targetId:
{
Description: ArmId of Target ,
Format: arm-id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Name of the solution instance ,
Required: False ,
}
string ,
}
,
]
,
solutionInstanceName:
{
Description: Name of the solution instance ,
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 (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_ListByResourceGroup (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Target items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: True ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: True ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: True ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: True ,
}
string ,
status:
{
Description: Status of target ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
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 ,
}
,
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 ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Targets_Get (new)
Description :  Get a Target Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: True ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: True ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: True ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: True ,
}
string ,
status:
{
Description: Status of target ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
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 ,
}
,
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 ,
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 ,
}
,
}

⚐ 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_CreateOrUpdate (new)
Description :  Create or update a Target Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}
{
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 ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: True ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: True ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: True ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: True ,
}
string ,
status:
{
Description: Status of target ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
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 ,
}
,
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 ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: True ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: True ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: True ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: True ,
}
string ,
status:
{
Description: Status of target ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
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 ,
}
,
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 ,
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 ,
}
,
}

⚐ 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: Target Resource. Represents a resource to be deployed on the edge. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: True ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: True ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: True ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: True ,
}
string ,
status:
{
Description: Status of target ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
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 ,
}
,
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 ,
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 ,
}
,
}
,
}

⚐ 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_Update (new)
Description :  update a Target Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}
{
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 ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: False ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: False ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: False ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: False ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: False ,
}
string ,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of target ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of target ,
Required: True ,
}
string ,
contextId:
{
Description: ArmId of Context ,
Format: arm-id ,
Required: True ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: True ,
}
object ,
capabilities:
{
Description: List of capabilities ,
Required: True ,
}
[
string ,
]
,
hierarchyLevel:
{
Description: Hierarchy Level ,
Required: True ,
}
string ,
status:
{
Description: Status of target ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
state:
{
Description: State of resource ,
Enum:
{
active: Resource is active ,
inactive: Resource is inactive ,
}
,
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 ,
}
,
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 ,
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 ,
}
,
}

⚐ 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_Delete (new)
Description :  Delete a Target Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}
{
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 ,
forceDelete:
{
Description: Force delete ,
Required: False ,
}
boolean ,
targetName:
{
Description: Name of the target ,
Required: True ,
}
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 (204)

{}

⚐ 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_InstallSolution (new)
Description :  Post request to deploy
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/installSolution
{
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 (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_PublishSolutionVersion (new)
Description :  Post request to publish
Reference :  Link ¶

⚼ 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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_RemoveRevision (new)
Description :  Post request to remove solution version revision
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/removeRevision
{
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 ,
}
{
solutionTemplateId:
{
Description: Solution Template ARM Id ,
Required: True ,
}
string ,
solutionVersion:
{
Description: Solution Version Name ,
Required: True ,
}
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_ResolveConfiguration (new)
Description :  Post request to resolve configuration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/resolveConfiguration
{
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)

{
configuration:
{
Description: Resolved Configuration as string ,
Required: True ,
}
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 (new)
Description :  Post request to review configuration
Reference :  Link ¶

⚼ 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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 ,
}
,
]
,
}
,
}
Solutions_ListByTarget (new)
Description :  List Solution resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Solution items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateId:
{
Description: Solution template Id ,
Required: False ,
}
string ,
availableSolutionTemplateVersions:
{
Description: List of latest revisions for available solution template versions ,
Required: False ,
}
[
{
solutionTemplateVersion:
{
Description: Solution template Version ,
Required: True ,
}
string ,
latestConfigRevision:
{
Description: Latest Configuration Revision ,
Required: True ,
}
string ,
isConfigured:
{
Description: Has this solution template version been configured ,
Required: True ,
}
boolean ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Solutions_Get (new)
Description :  Get a Solution resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}
{
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)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateId:
{
Description: Solution template Id ,
Required: False ,
}
string ,
availableSolutionTemplateVersions:
{
Description: List of latest revisions for available solution template versions ,
Required: False ,
}
[
{
solutionTemplateVersion:
{
Description: Solution template Version ,
Required: True ,
}
string ,
latestConfigRevision:
{
Description: Latest Configuration Revision ,
Required: True ,
}
string ,
isConfigured:
{
Description: Has this solution template version been configured ,
Required: True ,
}
boolean ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Solutions_CreateOrUpdate (new)
Description :  Create or update a Solution Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}
{
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 ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateId:
{
Description: Solution template Id ,
Required: False ,
}
string ,
availableSolutionTemplateVersions:
{
Description: List of latest revisions for available solution template versions ,
Required: False ,
}
[
{
solutionTemplateVersion:
{
Description: Solution template Version ,
Required: True ,
}
string ,
latestConfigRevision:
{
Description: Latest Configuration Revision ,
Required: True ,
}
string ,
isConfigured:
{
Description: Has this solution template version been configured ,
Required: True ,
}
boolean ,
}
,
]
,
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 ,
}
{
solutionTemplateId:
{
Description: Solution template Id ,
Required: False ,
}
string ,
availableSolutionTemplateVersions:
{
Description: List of latest revisions for available solution template versions ,
Required: False ,
}
[
{
solutionTemplateVersion:
{
Description: Solution template Version ,
Required: True ,
}
string ,
latestConfigRevision:
{
Description: Latest Configuration Revision ,
Required: True ,
}
string ,
isConfigured:
{
Description: Has this solution template version been configured ,
Required: True ,
}
boolean ,
}
,
]
,
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 Resource attached to a Target ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateId:
{
Description: Solution template Id ,
Required: False ,
}
string ,
availableSolutionTemplateVersions:
{
Description: List of latest revisions for available solution template versions ,
Required: False ,
}
[
{
solutionTemplateVersion:
{
Description: Solution template Version ,
Required: True ,
}
string ,
latestConfigRevision:
{
Description: Latest Configuration Revision ,
Required: True ,
}
string ,
isConfigured:
{
Description: Has this solution template version been configured ,
Required: True ,
}
boolean ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Solutions_Update (new)
Description :  Update a Solution Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}
{
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 ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateId:
{
Description: Solution template Id ,
Required: False ,
}
string ,
availableSolutionTemplateVersions:
{
Description: List of latest revisions for available solution template versions ,
Required: False ,
}
[
{
solutionTemplateVersion:
{
Description: Solution template Version ,
Required: True ,
}
string ,
latestConfigRevision:
{
Description: Latest Configuration Revision ,
Required: True ,
}
string ,
isConfigured:
{
Description: Has this solution template version been configured ,
Required: True ,
}
boolean ,
}
,
]
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionTemplateId:
{
Description: Solution template Id ,
Required: False ,
}
string ,
availableSolutionTemplateVersions:
{
Description: List of latest revisions for available solution template versions ,
Required: False ,
}
[
{
solutionTemplateVersion:
{
Description: Solution template Version ,
Required: True ,
}
string ,
latestConfigRevision:
{
Description: Latest Configuration Revision ,
Required: True ,
}
string ,
isConfigured:
{
Description: Has this solution template version been configured ,
Required: True ,
}
boolean ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Solutions_Delete (new)
Description :  Delete a Solution Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}
{
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 (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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Instances_ListBySolution (new)
Description :  List Instance Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/instances
{
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 Instance items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Required: True ,
}
string ,
targetId:
{
Description: Target of instance ,
Required: True ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
status:
{
Description: Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
deploymentTimestampEpoch:
{
Description: Deployment timestamp of instance ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
}
,
]
,
}
,
}
Instances_Get (new)
Description :  Get Instance Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/instances/{instanceName}
{
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 ,
instanceName:
{
Description: Name of the instance ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Required: True ,
}
string ,
targetId:
{
Description: Target of instance ,
Required: True ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
status:
{
Description: Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
deploymentTimestampEpoch:
{
Description: Deployment timestamp of instance ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
}
,
]
,
}
,
}
Instances_CreateOrUpdate (new)
Description :  Create or update Instance Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/instances/{instanceName}
{
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 ,
instanceName:
{
Description: Name of the instance ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Required: True ,
}
string ,
targetId:
{
Description: Target of instance ,
Required: True ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
status:
{
Description: Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
deploymentTimestampEpoch:
{
Description: Deployment timestamp of instance ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Required: True ,
}
string ,
targetId:
{
Description: Target of instance ,
Required: True ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
status:
{
Description: Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
deploymentTimestampEpoch:
{
Description: Deployment timestamp of instance ,
Format: int64 ,
Required: False ,
}
integer ,
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: Instance Resource. Represents a deployment object. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Required: True ,
}
string ,
targetId:
{
Description: Target of instance ,
Required: True ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
status:
{
Description: Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
deploymentTimestampEpoch:
{
Description: Deployment timestamp of instance ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
}
,
]
,
}
,
}
Instances_Update (new)
Description :  Update an Instance Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/instances/{instanceName}
{
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 ,
instanceName:
{
Description: Name of the instance ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Required: False ,
}
string ,
targetId:
{
Description: Target of instance ,
Required: False ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: False ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Required: True ,
}
string ,
targetId:
{
Description: Target of instance ,
Required: True ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
status:
{
Description: Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
deploymentTimestampEpoch:
{
Description: Deployment timestamp of instance ,
Format: int64 ,
Required: False ,
}
integer ,
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 ,
}
,
]
,
}
,
}
Instances_Delete (new)
Description :  Delete Instance Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/instances/{instanceName}
{
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 ,
instanceName:
{
Description: Name of the instance ,
Required: True ,
}
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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
InstanceHistories_ListByInstance (new)
Description :  List InstanceHistory Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/instances/{instanceName}/histories
{
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 ,
instanceName:
{
Description: Name of the instance ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InstanceHistory items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersion:
{
Description: Solution version of instance ,
Required: True ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: False ,
}
object ,
}
,
target:
{
Description: Target of instance ,
Required: True ,
}
{
targetId:
{
Description: Target of instance ,
Format: arm-id ,
Required: False ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: False ,
}
object ,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
status:
{
Description: Deployment Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
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 ,
}
,
]
,
}
,
}
InstanceHistories_Get (new)
Description :  Get InstanceHistory Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/solutions/{solutionName}/instances/{instanceName}/histories/{instanceHistoryName}
{
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 ,
instanceName:
{
Description: Name of the instance ,
Required: True ,
}
string ,
instanceHistoryName:
{
Description: Name of the instance history ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionVersion:
{
Description: Solution version of instance ,
Required: True ,
}
{
solutionVersionId:
{
Description: Solution version of instance ,
Format: arm-id ,
Required: False ,
}
string ,
specification:
{
Description: App components spec ,
Required: False ,
}
object ,
}
,
target:
{
Description: Target of instance ,
Required: True ,
}
{
targetId:
{
Description: Target of instance ,
Format: arm-id ,
Required: False ,
}
string ,
targetSpecification:
{
Description: target spec ,
Required: False ,
}
object ,
solutionScope:
{
Description: Scope of the target resource ,
Required: False ,
}
string ,
}
,
solutionScope:
{
Description: Scope of instance ,
Required: False ,
}
string ,
activeState:
{
Description: State of instance ,
Enum:
{
active: Instance is active ,
inactive: Instance is inactive ,
}
,
Required: False ,
}
enum ,
reconciliationPolicy:
{
Description: Reconciliation policy of instance ,
Required: False ,
}
{
state:
{
Description: The state of the ReconciliationPolicy ,
Enum:
{
inactive: Reconciliation is inactive ,
active: Reconciliation is active ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: Policy interval ,
Required: True ,
}
string ,
}
,
status:
{
Description: Deployment Status of instance ,
Required: False ,
}
{
lastModified:
{
Description: The lastModified of the Status ,
Format: date-time ,
Required: False ,
}
string ,
deployed:
{
Description: Indicates if Instance is deployed ,
Format: int32 ,
Required: False ,
}
integer ,
expectedRunningJobId:
{
Description: The expected running job id ,
Format: int32 ,
Required: False ,
}
integer ,
runningJobId:
{
Description: The running job id ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Deployment status ,
Required: False ,
}
string ,
statusDetails:
{
Description: Status details ,
Required: False ,
}
string ,
generation:
{
Description: Deployment Generation ,
Format: int32 ,
Required: False ,
}
integer ,
targetStatuses:
{
Description: Target resource statuses ,
Required: False ,
}
[
{
name:
{
Description: Target name ,
Required: False ,
}
string ,
status:
{
Description: Target status ,
Required: False ,
}
string ,
componentStatuses:
{
Description: Component statuses ,
Required: False ,
}
[
{
name:
{
Description: Component name ,
Required: False ,
}
string ,
status:
{
Description: Component status ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
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_ListBySolution (new)
Description :  List Solution Version Resources
Reference :  Link ¶

⚼ 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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 (new)
Description :  Get a Solution Version Resource
Reference :  Link ¶

⚼ 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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 (new)
Description :  Create or update a Solution Version Resource
Reference :  Link ¶

⚼ 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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 (new)
Description :  Update a Solution Version Resource
Reference :  Link ¶

⚼ 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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_Delete (new)
Description :  Delete a Solution Version Resource
Reference :  Link ¶

⚼ Request

DELETE:  /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 (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 (204)

{}

⚐ 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_UninstallSolution (new)
Description :  Post request to uninstall
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/targets/{targetName}/uninstallSolution
{
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 ,
}
{
solutionTemplateId:
{
Description: Solution Template ARM Id ,
Required: True ,
}
string ,
solutionInstanceName:
{
Description: Solution Instance Name ,
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 (new)
Description :  Post request to update external validation status
Reference :  Link ¶

⚼ 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 ,
}
,
Required: False ,
}
enum ,
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 ,
actionType:
{
Description: The type of the latest action performed on this solution version. ,
Enum:
{
deploy: A deployment 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 ,
}
,
]
,
}
,
}
ConfigurationReferences_List (new)
Description :  List ConfigurationReference resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Edge/configurationReferences
{
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 ConfigurationReference items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
configurationResourceId:
{
Description: ArmId of Configuration resource ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
ConfigurationReferences_Get (new)
Description :  Get a ConfigurationReference
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Edge/configurationReferences/{configurationReferenceName}
{
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 ,
configurationReferenceName:
{
Description: The name of the ConfigurationReference ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
configurationResourceId:
{
Description: ArmId of Configuration resource ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
ConfigurationReferences_CreateOrUpdate (new)
Description :  Create a ConfigurationReference
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.Edge/configurationReferences/{configurationReferenceName}
{
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 ,
configurationReferenceName:
{
Description: The name of the ConfigurationReference ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
configurationResourceId:
{
Description: ArmId of Configuration resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
configurationResourceId:
{
Description: ArmId of Configuration resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
configurationResourceId:
{
Description: ArmId of Configuration resource ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
ConfigurationReferences_Update (new)
Description :  Update a ConfigurationReference
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.Edge/configurationReferences/{configurationReferenceName}
{
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 ,
configurationReferenceName:
{
Description: The name of the ConfigurationReference ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
configurationResourceId:
{
Description: ArmId of Configuration resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
configurationResourceId:
{
Description: ArmId of Configuration resource ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
ConfigurationReferences_Delete (new)
Description :  Delete a ConfigurationReference
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.Edge/configurationReferences/{configurationReferenceName}
{
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 ,
configurationReferenceName:
{
Description: The name of the ConfigurationReference ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Configurations_ListBySubscription (new)
Description :  List by subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Edge/configurations
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Configuration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_ListByResourceGroup (new)
Description :  List by specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Configuration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_Get (new)
Description :  Get a Configuration Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Configurations_CreateOrUpdate (new)
Description :  Create or update a Configuration Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Configurations_Update (new)
Description :  Update a Configuration Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Configurations_Delete (new)
Description :  Delete a Configuration Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurations_ListByConfiguration (new)
Description :  List Dynamic Configuration Resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DynamicConfiguration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationType:
{
Description: Type of dynamic configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
dynamicConfigurationModel:
{
Description: Type of dynamic configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
DynamicConfigurations_Get (new)
Description :  Get a Dynamic Configuration Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationType:
{
Description: Type of dynamic configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
dynamicConfigurationModel:
{
Description: Type of dynamic configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurations_CreateOrUpdate (new)
Description :  Create or update a Dynamic Configuration Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationType:
{
Description: Type of dynamic configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
dynamicConfigurationModel:
{
Description: Type of dynamic configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationType:
{
Description: Type of dynamic configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
dynamicConfigurationModel:
{
Description: Type of dynamic configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
}

⚐ 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: Dynamic Configuration Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationType:
{
Description: Type of dynamic configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
dynamicConfigurationModel:
{
Description: Type of dynamic configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurations_Update (new)
Description :  Update a Dynamic Configuration Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of dynamic configuration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
currentVersion:
{
Description: Current Version of dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationType:
{
Description: Type of dynamic configuration ,
Enum:
{
Shared: Configuration type Shared ,
Hierarchy: Configuration type Hierarchy ,
}
,
Required: False ,
}
enum ,
dynamicConfigurationModel:
{
Description: Type of dynamic configuration model ,
Enum:
{
Application: Configuration model Application ,
Common: Configuration model Common ,
}
,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurations_Delete (new)
Description :  Delete a Dynamic Configuration Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurationVersions_ListByDynamicConfiguration (new)
Description :  List Dynamic Configuration Version Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}/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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DynamicConfigurationVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
values:
{
Description: Values of configuration version ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema Id for configuration ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
DynamicConfigurationVersions_Get (new)
Description :  Get a Dynamic Configuration Version Resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}/versions/{dynamicConfigurationVersionName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationVersionName:
{
Description: The name of the DynamicConfigurationVersion ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
values:
{
Description: Values of configuration version ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema Id for configuration ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurationVersions_CreateOrUpdate (new)
Description :  Create or update a Dynamic Configuration Version Resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}/versions/{dynamicConfigurationVersionName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationVersionName:
{
Description: The name of the DynamicConfigurationVersion ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
values:
{
Description: Values of configuration version ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema Id for configuration ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
values:
{
Description: Values of configuration version ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema Id for configuration ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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: Dynamic Configuration Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
values:
{
Description: Values of configuration version ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema Id for configuration ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurationVersions_Update (new)
Description :  update a Dynamic Configuration Version Resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}/versions/{dynamicConfigurationVersionName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationVersionName:
{
Description: The name of the DynamicConfigurationVersion ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
values:
{
Description: Values of configuration version ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
values:
{
Description: Values of configuration version ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema Id for configuration ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DynamicConfigurationVersions_Delete (new)
Description :  Delete a Dynamic Configuration Version Resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/configurations/{configurationName}/dynamicConfigurations/{dynamicConfigurationName}/versions/{dynamicConfigurationVersionName}
{
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 ,
configurationName:
{
Description: Name of the Configuration ,
Required: True ,
}
string ,
dynamicConfigurationName:
{
Description: Name of the dynamic configuration ,
Required: True ,
}
string ,
dynamicConfigurationVersionName:
{
Description: The name of the DynamicConfigurationVersion ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}