Microsoft.Logz (preview:2022-01-01)

2025/02/28 • 41 deleted methods

Monitors_ListMonitoredResources (removed)
Description :  List the resources currently being monitored by the Logz monitor resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/listMonitoredResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
sendingMetrics:
{
Description: Flag indicating if resource is sending metrics to Logz. ,
Required: False ,
}
boolean ,
reasonForMetricsStatus:
{
Description: Reason for why the resource is sending metrics (or why it is not sending). ,
Required: False ,
}
string ,
sendingLogs:
{
Description: Flag indicating if resource is sending logs to Logz. ,
Required: False ,
}
boolean ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reasonForLogsStatus:
{
Description: Reason for why the resource is sending logs (or why it is not sending). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List all operations provided by Microsoft.Logz.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Microsoft.Logz provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name, i.e., {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider, i.e., Microsoft.Logz. ,
Required: False ,
}
string ,
resource:
{
Description: Type on which the operation is performed, e.g., 'monitors'. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type, e.g., read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation, e.g., 'Write monitors'. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitors_ListBySubscription (removed)
Description :  List all monitors under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Logz/monitors
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitors_ListByResourceGroup (removed)
Description :  List all monitors under the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitors_Get (removed)
Description :  Get the properties of a specific monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitors_Create (removed)
Description :  Create a monitor resource. This create operation can take upto 10 minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitors_Update (removed)
Description :  Update a monitor resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
properties:
{
Description: The set of properties that can be update in a PATCH request to a monitor resource. ,
Required: False ,
}
{
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The new tags of the monitor resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitors_Delete (removed)
Description :  Delete a monitor resource. This delete operation can take upto 10 minutes to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
TagRules_List (removed)
Description :  List the tag rules for a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/tagRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TagRules_CreateOrUpdate (removed)
Description :  Create or update a tag rule set for a given monitor resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TagRules_Get (removed)
Description :  Get a tag rule set for a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TagRules_Delete (removed)
Description :  Delete a tag rule set for a given monitor resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
SingleSignOn_List (removed)
Description :  List the single sign-on configurations for a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/singleSignOnConfigurations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
singleSignOnState:
{
Description: Various states of the SSO resource ,
Enum:
{
Initial: No description available. ,
Enable: No description available. ,
Disable: No description available. ,
Existing: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign-on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SingleSignOn_CreateOrUpdate (removed)
Description :  Configures single-sign-on for this resource. This operation can take upto 10 minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
configurationName:
{
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
singleSignOnState:
{
Description: Various states of the SSO resource ,
Enum:
{
Initial: No description available. ,
Enable: No description available. ,
Disable: No description available. ,
Existing: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign-on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
singleSignOnState:
{
Description: Various states of the SSO resource ,
Enum:
{
Initial: No description available. ,
Enable: No description available. ,
Disable: No description available. ,
Existing: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign-on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
id:
{
Description: ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
singleSignOnState:
{
Description: Various states of the SSO resource ,
Enum:
{
Initial: No description available. ,
Enable: No description available. ,
Disable: No description available. ,
Existing: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign-on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SingleSignOn_Get (removed)
Description :  Gets the Logz single sign-on resource for the given Monitor.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
configurationName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
singleSignOnState:
{
Description: Various states of the SSO resource ,
Enum:
{
Initial: No description available. ,
Enable: No description available. ,
Disable: No description available. ,
Existing: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign-on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_List (removed)
Description :  List the sub account under a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_Create (removed)
Description :  Create sub account under a given monitor resource. This create operation can take upto 10 minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_Get (removed)
Description :  Get a sub account under a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_Delete (removed)
Description :  Delete a sub account resource. This delete operation can take upto 10 minutes to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_Update (removed)
Description :  Update a monitor resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
properties:
{
Description: The set of properties that can be update in a PATCH request to a monitor resource. ,
Required: False ,
}
{
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The new tags of the monitor resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccountTagRules_List (removed)
Description :  List the tag rules for a given sub account resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/tagRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccountTagRules_CreateOrUpdate (removed)
Description :  Create or update a tag rule set for a given sub account resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccountTagRules_Get (removed)
Description :  Get a tag rule set for a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Set of rules for sending logs for the Monitor resource. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccountTagRules_Delete (removed)
Description :  Delete a tag rule set for a given monitor resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_ListMonitoredResources (removed)
Description :  List the resources currently being monitored by the Logz sub account resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/listMonitoredResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
sendingMetrics:
{
Description: Flag indicating if resource is sending metrics to Logz. ,
Required: False ,
}
boolean ,
reasonForMetricsStatus:
{
Description: Reason for why the resource is sending metrics (or why it is not sending). ,
Required: False ,
}
string ,
sendingLogs:
{
Description: Flag indicating if resource is sending logs to Logz. ,
Required: False ,
}
boolean ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reasonForLogsStatus:
{
Description: Reason for why the resource is sending logs (or why it is not sending). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_VMHostPayload (removed)
Description :  Returns the payload that needs to be passed as a request for installing Logz.io agent on a VM.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/vmHostPayload
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
apiKey:
{
Description: API Key corresponding to the resource. ,
Required: False ,
}
string ,
region:
{
Description: Logz.io region where the resource has been created. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_ListVmHostUpdate (removed)
Description :  Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/vmHostUpdate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body to update the collection for agent installed in the given monitor. ,
Required: False ,
}
{
vmResourceIds:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
[
{
id:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
string ,
agentVersion:
{
Description: Version of the Logz agent installed on the VM. ,
Required: False ,
}
string ,
}
,
]
,
state:
{
Description: Specifies the state of the operation - install/ delete. ,
Enum:
{
Install: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Response of a list vm host update operation. ,
Required: False ,
}
[
{
id:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
string ,
agentVersion:
{
Description: Version of the Logz agent installed on the VM. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SubAccount_ListVMHosts (removed)
Description :  List the compute resources currently being monitored by the Logz sub account resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/listVMHosts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
subAccountName:
{
Description: Sub Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Response of a list vm host update operation. ,
Required: False ,
}
[
{
id:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
string ,
agentVersion:
{
Description: Version of the Logz agent installed on the VM. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSource_List (removed)
Description :  List the metrics accounts under a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSource_Create (removed)
Description :  Create metrics account under a given monitor resource. This create operation can take upto 10 minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSource_Get (removed)
Description :  Get a metrics account under a given monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSource_Delete (removed)
Description :  Delete a metrics account resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSource_Update (removed)
Description :  Update a metrics resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
properties:
{
Description: The set of properties that can be update in a PATCH request to a monitor resource. ,
Required: False ,
}
{
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The new tags of the monitor resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
marketplaceSubscriptionStatus:
{
Description: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. ,
Enum:
{
Active: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
logzOrganizationProperties:
{
Required: False ,
}
{
companyName:
{
Description: Name of the Logz organization. ,
Required: False ,
}
string ,
id:
{
Description: Id of the Logz organization. ,
Required: False ,
}
string ,
enterpriseAppId:
{
Description: The Id of the Enterprise App used for Single sign on. ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: The login URL specific to this Logz Organization. ,
Required: False ,
}
string ,
}
,
userInfo:
{
Required: False ,
}
{
firstName:
{
Description: First Name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
planData:
{
Required: False ,
}
{
usageType:
{
Description: different usage type like PAYG/COMMITTED. this could be enum ,
Required: False ,
}
string ,
billingCycle:
{
Description: different billing cycles like MONTHLY/WEEKLY. this could be enum ,
Required: False ,
}
string ,
planDetails:
{
Description: plan id as published by Logz ,
Required: False ,
}
string ,
effectiveDate:
{
Description: date when plan was applied ,
Format: date-time ,
Required: False ,
}
string ,
}
,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
location:
{
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSourceTagRules_List (removed)
Description :  List the tag rules for a given metrics resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}/tagRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
sendMetrics:
{
Description: Flag specifying if metrics from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
metricRules:
{
Required: False ,
}
[
{
subscriptionId:
{
Description: Subscription Id for which filtering tags are applicable ,
Required: False ,
}
string ,
filteringTags:
{
Description: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSourceTagRules_CreateOrUpdate (removed)
Description :  Create or update a tag rule set for a given metrics resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
sendMetrics:
{
Description: Flag specifying if metrics from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
metricRules:
{
Required: False ,
}
[
{
subscriptionId:
{
Description: Subscription Id for which filtering tags are applicable ,
Required: False ,
}
string ,
filteringTags:
{
Description: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
sendMetrics:
{
Description: Flag specifying if metrics from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
metricRules:
{
Required: False ,
}
[
{
subscriptionId:
{
Description: Subscription Id for which filtering tags are applicable ,
Required: False ,
}
string ,
filteringTags:
{
Description: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSourceTagRules_Get (removed)
Description :  Get a tag rule set for a given metrics resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Flag specifying if the resource provisioning state as tracked by ARM. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
sendMetrics:
{
Description: Flag specifying if metrics from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
metricRules:
{
Required: False ,
}
[
{
subscriptionId:
{
Description: Subscription Id for which filtering tags are applicable ,
Required: False ,
}
string ,
filteringTags:
{
Description: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. Exclusion takes priority over inclusion. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MetricsSourceTagRules_Delete (removed)
Description :  Delete a tag rule set for a given metrics resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/metricsSource/{metricsSourceName}/tagRules/{ruleSetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
metricsSourceName:
{
Description: Metrics Account resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitor_VMHostPayload (removed)
Description :  Returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/vmHostPayload
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
apiKey:
{
Description: API Key corresponding to the resource. ,
Required: False ,
}
string ,
region:
{
Description: Logz.io region where the resource has been created. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitor_ListVmHostUpdate (removed)
Description :  Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/vmHostUpdate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body to update the collection for agent installed in the given monitor. ,
Required: False ,
}
{
vmResourceIds:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
[
{
id:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
string ,
agentVersion:
{
Description: Version of the Logz agent installed on the VM. ,
Required: False ,
}
string ,
}
,
]
,
state:
{
Description: Specifies the state of the operation - install/ delete. ,
Enum:
{
Install: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Response of a list vm host update operation. ,
Required: False ,
}
[
{
id:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
string ,
agentVersion:
{
Description: Version of the Logz agent installed on the VM. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitor_ListVMHosts (removed)
Description :  List the compute resources currently being monitored by the Logz main account resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/listVMHosts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Response of a list vm host update operation. ,
Required: False ,
}
[
{
id:
{
Description: Request of a list vm host update operation. ,
Required: False ,
}
string ,
agentVersion:
{
Description: Version of the Logz agent installed on the VM. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Monitors_ListUserRoles (removed)
Description :  List the user's roles configured on Logz.io side for the account corresponding to the monitor resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/listUserRoles
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
emailAddress:
{
Description: Email of the user used by Logz for contacting them if needed ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of user roles for Logz.io account. ,
Required: False ,
}
[
{
role:
{
Description: User roles on configured in Logz.io account. ,
Enum:
{
None: No description available. ,
User: No description available. ,
Admin: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}