Microsoft.OperationalInsights (preview:2024-10-01)

2026/01/07 • 11 deleted methods

BusinessApplicationAgents_CreateOrUpdate (removed)
Description :  Creates or updates the Business Application Agent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
agentToUpsert:
{
Description: The Business Application Agent ,
Required: False ,
}
{
properties:
{
Required: True ,
}
{
configuration:
{
Description: Describes the configuration of a Business Application Agent. ,
Required: True ,
}
{
type:
{
Description: Type of the agent ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
agentSystems:
{
Required: False ,
}
[
{
systemResourceName:
{
Required: False ,
}
string ,
systemDisplayName:
{
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
configuration:
{
Description: Describes the configuration of a Business Application Agent. ,
Required: True ,
}
{
type:
{
Description: Type of the agent ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
agentSystems:
{
Required: False ,
}
[
{
systemResourceName:
{
Required: False ,
}
string ,
systemDisplayName:
{
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: True ,
}
{
configuration:
{
Description: Describes the configuration of a Business Application Agent. ,
Required: True ,
}
{
type:
{
Description: Type of the agent ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
agentSystems:
{
Required: False ,
}
[
{
systemResourceName:
{
Required: False ,
}
string ,
systemDisplayName:
{
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
BusinessApplicationAgent_Get (removed)
Description :  Gets Business Application Agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
configuration:
{
Description: Describes the configuration of a Business Application Agent. ,
Required: True ,
}
{
type:
{
Description: Type of the agent ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
agentSystems:
{
Required: False ,
}
[
{
systemResourceName:
{
Required: False ,
}
string ,
systemDisplayName:
{
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
BusinessApplicationAgents_Delete (removed)
Description :  Delete the Business Application Agent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
BusinessApplicationAgents_List (removed)
Description :  Gets all Business Application Agents under the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Filters the results, based on a Boolean condition. Optional. ,
Required: False ,
}
string ,
$skipToken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
configuration:
{
Description: Describes the configuration of a Business Application Agent. ,
Required: True ,
}
{
type:
{
Description: Type of the agent ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
agentSystems:
{
Required: False ,
}
[
{
systemResourceName:
{
Required: False ,
}
string ,
systemDisplayName:
{
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
Systems_CreateOrUpdate (removed)
Description :  Creates or updates the system.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
systemResourceName:
{
Description: The name of the system. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
systemToUpsert:
{
Description: The system to upsert. ,
Required: False ,
}
{
properties:
{
Description: The properties of the system. ,
Required: True ,
}
{
status:
{
Description: The status of the system. ,
Enum:
{
Running: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: The configuration of the system. ,
Required: True ,
}
{
type:
{
Description: Represents the types of configuration for a system. ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the system. ,
Required: True ,
}
{
status:
{
Description: The status of the system. ,
Enum:
{
Running: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: The configuration of the system. ,
Required: True ,
}
{
type:
{
Description: Represents the types of configuration for a system. ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the system. ,
Required: True ,
}
{
status:
{
Description: The status of the system. ,
Enum:
{
Running: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: The configuration of the system. ,
Required: True ,
}
{
type:
{
Description: Represents the types of configuration for a system. ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
Systems_Get (removed)
Description :  Gets the system.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
systemResourceName:
{
Description: The name of the system. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the system. ,
Required: True ,
}
{
status:
{
Description: The status of the system. ,
Enum:
{
Running: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: The configuration of the system. ,
Required: True ,
}
{
type:
{
Description: Represents the types of configuration for a system. ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
Systems_Delete (removed)
Description :  Deletes the system.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
systemResourceName:
{
Description: The name of the system. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
Systems_List (removed)
Description :  ListAll the systems.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Filters the results, based on a Boolean condition. Optional. ,
Required: False ,
}
string ,
$skipToken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The properties of the system. ,
Required: True ,
}
{
status:
{
Description: The status of the system. ,
Enum:
{
Running: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
configuration:
{
Description: The configuration of the system. ,
Required: True ,
}
{
type:
{
Description: Represents the types of configuration for a system. ,
Enum:
{
SAP: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Required: True ,
}
string ,
lastModifiedTimeUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
Systems_ListActions (removed)
Description :  List of actions for a business application system.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}/listActions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
systemResourceName:
{
Description: The name of the system. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of actions. ,
Required: True ,
}
[
{
kind:
{
Description: The actions kind ,
Enum:
{
LockUser: No description available. ,
UnlockUser: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of actions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
Systems_UndoAction (removed)
Description :  Undo action, based on the actionId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}/undoAction
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
systemResourceName:
{
Description: The name of the system. ,
Required: True ,
}
string ,
payload:
{
Description: Undo action, based on the actionId. ,
Required: False ,
}
{
actionId:
{
Description: The action ID of the original action that was performed and now need to undo ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
Systems_ReportActionStatus (removed)
Description :  Report the status of the action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems/{systemResourceName}/reportActionStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
agentResourceName:
{
Description: Business Application Agent Name ,
Required: True ,
}
string ,
systemResourceName:
{
Description: The name of the system. ,
Required: True ,
}
string ,
payload:
{
Description: Report a status of the action that was performed by the agent ,
Required: False ,
}
{
actionId:
{
Description: The action ID to perform ,
Required: False ,
}
string ,
actionStatus:
{
Description: The status of the action that was performed by the agent ,
Required: False ,
}
string ,
failureReason:
{
Description: The reason of the failure of the action. Empty if the action is successful. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}