Microsoft.LoadTestService (preview:2024-12-01)

2024/12/30 • 4 new methods

NotificationRuleAdministration_ListNotificationRule (new)
Description :  Resource list operation template.
Reference :  Link ¶

⚼ Request

GET:  /notification-rules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testIds:
{
Description: Search based on notification rules associated with the provided test ids. ,
Required: False ,
}
string ,
scopes:
{
Description: Search based on notification rules for the provided scopes. ,
Required: False ,
}
string ,
lastModifiedStartTime:
{
Description: Start DateTime(RFC 3339 literal format) of the last updated time range to filter notification rules. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedEndTime:
{
Description: End DateTime(RFC 3339 literal format) of the last updated time range to filter notification rules. ,
Format: date-time ,
Required: False ,
}
string ,
maxpagesize:
{
Description: Number of results in response. Default page size is 50. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The NotificationRule items on this page ,
Required: True ,
}
[
{
notificationRuleId:
{
Description: The unique identifier of the notification rule. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the notification rule. ,
Required: True ,
}
string ,
actionGroupIds:
{
Description: The action groups to notify. ,
Required: True ,
}
[
string ,
]
,
scope:
{
Description: The scope of the notification rule. ,
Enum:
{
Tests: Notification rule is for Tests. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
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 ,
}
,
}
,
}
,
}
NotificationRuleAdministration_GetNotificationRule (new)
Description :  Resource read operation template.
Reference :  Link ¶

⚼ Request

GET:  /notification-rules/{notificationRuleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
notificationRuleId:
{
Description: The unique identifier of the notification rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
notificationRuleId:
{
Description: The unique identifier of the notification rule. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the notification rule. ,
Required: True ,
}
string ,
actionGroupIds:
{
Description: The action groups to notify. ,
Required: True ,
}
[
string ,
]
,
scope:
{
Description: The scope of the notification rule. ,
Enum:
{
Tests: Notification rule is for Tests. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
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 ,
}
,
}
,
}
,
}
NotificationRuleAdministration_CreateOrUpdateNotificationRule (new)
Description :  Create or update operation template.
Reference :  Link ¶

⚼ Request

PATCH:  /notification-rules/{notificationRuleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
notificationRuleId:
{
Description: The unique identifier of the notification rule. ,
Required: True ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
displayName:
{
Description: The name of the notification rule. ,
Required: False ,
}
string ,
actionGroupIds:
{
Description: The action groups to notify. ,
Required: False ,
}
[
string ,
]
,
scope:
{
Description: The scope of the notification rule. ,
Enum:
{
Tests: Notification rule is for Tests. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
notificationRuleId:
{
Description: The unique identifier of the notification rule. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the notification rule. ,
Required: True ,
}
string ,
actionGroupIds:
{
Description: The action groups to notify. ,
Required: True ,
}
[
string ,
]
,
scope:
{
Description: The scope of the notification rule. ,
Enum:
{
Tests: Notification rule is for Tests. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
notificationRuleId:
{
Description: The unique identifier of the notification rule. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the notification rule. ,
Required: True ,
}
string ,
actionGroupIds:
{
Description: The action groups to notify. ,
Required: True ,
}
[
string ,
]
,
scope:
{
Description: The scope of the notification rule. ,
Enum:
{
Tests: Notification rule is for Tests. ,
}
,
Required: True ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
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 ,
}
,
}
,
}
,
}
NotificationRuleAdministration_DeleteNotificationRule (new)
Description :  Resource delete operation template.
Reference :  Link ¶

⚼ Request

DELETE:  /notification-rules/{notificationRuleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
notificationRuleId:
{
Description: The unique identifier of the notification rule. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

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