Azure.Contoso.WidgetManager (stable:2022-12-01)

2025/03/10 • 5 new methods

Widgets_ListWidgets (new)
Description :  List Widget resources
Reference :  Link ¶

⚼ Request

GET:  /widgets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WidgetSuite items on this page ,
Required: True ,
}
[
{
name:
{
Description: The widget name. ,
Required: True ,
}
string ,
manufacturerId:
{
Description: The ID of the widget's manufacturer. ,
Required: True ,
}
string ,
sharedModel:
{
Description: The faked shared model. ,
Required: False ,
}
{
tag:
{
Description: The tag. ,
Required: True ,
}
string ,
createdAt:
{
Description: The created date. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Widgets_GetWidget (new)
Description :  Fetch a Widget by name.
Reference :  Link ¶

⚼ Request

GET:  /widgets/{widgetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
widgetName:
{
Description: The widget name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The widget name. ,
Required: True ,
}
string ,
manufacturerId:
{
Description: The ID of the widget's manufacturer. ,
Required: True ,
}
string ,
sharedModel:
{
Description: The faked shared model. ,
Required: False ,
}
{
tag:
{
Description: The tag. ,
Required: True ,
}
string ,
createdAt:
{
Description: The created date. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Widgets_CreateOrUpdateWidget (new)
Description :  Creates or updates a Widget asynchronously.
Reference :  Link ¶

⚼ Request

PATCH:  /widgets/{widgetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
widgetName:
{
Description: The widget name. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
manufacturerId:
{
Description: The ID of the widget's manufacturer. ,
Required: False ,
}
string ,
sharedModel:
{
Description: The faked shared model. ,
Required: False ,
}
{
tag:
{
Description: The tag. ,
Required: False ,
}
string ,
createdAt:
{
Description: The created date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: A widget. ,
}
{
name:
{
Description: The widget name. ,
Required: True ,
}
string ,
manufacturerId:
{
Description: The ID of the widget's manufacturer. ,
Required: True ,
}
string ,
sharedModel:
{
Description: The faked shared model. ,
Required: False ,
}
{
tag:
{
Description: The tag. ,
Required: True ,
}
string ,
createdAt:
{
Description: The created date. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: A widget. ,
}
{
name:
{
Description: The widget name. ,
Required: True ,
}
string ,
manufacturerId:
{
Description: The ID of the widget's manufacturer. ,
Required: True ,
}
string ,
sharedModel:
{
Description: The faked shared model. ,
Required: False ,
}
{
tag:
{
Description: The tag. ,
Required: True ,
}
string ,
createdAt:
{
Description: The created date. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Widgets_DeleteWidget (new)
Description :  Delete a Widget asynchronously.
Reference :  Link ¶

⚼ Request

DELETE:  /widgets/{widgetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
widgetName:
{
Description: The widget name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Widgets_GetWidgetOperationStatus (new)
Description :  Gets status of a Widget operation.
Reference :  Link ¶

⚼ Request

GET:  /widgets/{widgetName}/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
widgetName:
{
Description: The widget name. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
name:
{
Description: The widget name. ,
Required: True ,
}
string ,
manufacturerId:
{
Description: The ID of the widget's manufacturer. ,
Required: True ,
}
string ,
sharedModel:
{
Description: The faked shared model. ,
Required: False ,
}
{
tag:
{
Description: The tag. ,
Required: True ,
}
string ,
createdAt:
{
Description: The created date. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}