Microsoft.OperationsManagement (preview:2015-11-01)

2025/09/19 • 15 new, 15 deleted methods

Solutions_CreateOrUpdate (new)
Description :  Creates or updates the Solution.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create OMS Solution. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_Update (new)
Description :  Patch a Solution. Only updating tags supported.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a Solution. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_Delete (new)
Description :  Deletes the solution in the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_Get (new)
Description :  Retrieves the user solution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_ListByResourceGroup (new)
Description :  Retrieves the solution list. It will retrieve both first party and third party solutions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_ListBySubscription (new)
Description :  Retrieves the solution list. It will retrieve both first party and third party solutions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationsManagement/solutions
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_ListBySubscription (new)
Description :  Retrieves the ManagementAssociations list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationsManagement/ManagementAssociations
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Management Association properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_CreateOrUpdate (new)
Description :  Creates or updates the ManagementAssociation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.OperationsManagement/ManagementAssociations/{managementAssociationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
providerName:
{
Description: Provider name for the parent resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type for the parent resource ,
Required: True ,
}
string ,
resourceName:
{
Description: Parent resource name. ,
Required: True ,
}
string ,
managementAssociationName:
{
Description: User ManagementAssociation Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create ManagementAssociation extension. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_Delete (new)
Description :  Deletes the ManagementAssociation in the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.OperationsManagement/ManagementAssociations/{managementAssociationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Provider name for the parent resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type for the parent resource ,
Required: True ,
}
string ,
resourceName:
{
Description: Parent resource name. ,
Required: True ,
}
string ,
managementAssociationName:
{
Description: User ManagementAssociation Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_Get (new)
Description :  Retrieves the user ManagementAssociation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.OperationsManagement/ManagementAssociations/{managementAssociationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Provider name for the parent resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type for the parent resource ,
Required: True ,
}
string ,
resourceName:
{
Description: Parent resource name. ,
Required: True ,
}
string ,
managementAssociationName:
{
Description: User ManagementAssociation Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_ListBySubscription (new)
Description :  Retrieves the ManagementConfigurations list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationsManagement/ManagementConfigurations
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Management Configuration properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_CreateOrUpdate (new)
Description :  Creates or updates the ManagementConfiguration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/ManagementConfigurations/{managementConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
managementConfigurationName:
{
Description: User Management Configuration Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create OMS Solution. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_Delete (new)
Description :  Deletes the ManagementConfiguration in the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/ManagementConfigurations/{managementConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
managementConfigurationName:
{
Description: User Management Configuration Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_Get (new)
Description :  Retrieves the user ManagementConfiguration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/ManagementConfigurations/{managementConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
managementConfigurationName:
{
Description: User Management Configuration Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available OperationsManagement Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.OperationsManagement/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution operations supported by the OperationsManagement resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft OperationsManagement. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Solutions_CreateOrUpdate (removed)
Description :  Creates or updates the Solution.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create OMS Solution. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_Update (removed)
Description :  Patch a Solution. Only updating tags supported.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a Solution. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_Delete (removed)
Description :  Deletes the solution in the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_Get (removed)
Description :  Retrieves the user solution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
solutionName:
{
Description: User Solution Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_ListByResourceGroup (removed)
Description :  Retrieves the solution list. It will retrieve both first party and third party solutions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Solutions_ListBySubscription (removed)
Description :  Retrieves the solution list. It will retrieve both first party and third party solutions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationsManagement/solutions
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
plan:
{
Description: Plan for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
name:
{
Description: name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher name. For gallery solution, it is Microsoft. ,
Required: False ,
}
string ,
promotionCode:
{
Description: promotionCode, Not really used now, can you left as empty ,
Required: False ,
}
string ,
product:
{
Description: name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties for solution object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
workspaceResourceId:
{
Description: The azure resourceId for the workspace where the solution will be deployed/enabled. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state for the solution. ,
Required: False ,
}
string ,
containedResources:
{
Description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. ,
Required: False ,
}
[
string ,
]
,
referencedResources:
{
Description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_ListBySubscription (removed)
Description :  Retrieves the ManagementAssociations list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationsManagement/ManagementAssociations
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Management Association properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_CreateOrUpdate (removed)
Description :  Creates or updates the ManagementAssociation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.OperationsManagement/ManagementAssociations/{managementAssociationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
providerName:
{
Description: Provider name for the parent resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type for the parent resource ,
Required: True ,
}
string ,
resourceName:
{
Description: Parent resource name. ,
Required: True ,
}
string ,
managementAssociationName:
{
Description: User ManagementAssociation Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create ManagementAssociation extension. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_Delete (removed)
Description :  Deletes the ManagementAssociation in the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.OperationsManagement/ManagementAssociations/{managementAssociationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Provider name for the parent resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type for the parent resource ,
Required: True ,
}
string ,
resourceName:
{
Description: Parent resource name. ,
Required: True ,
}
string ,
managementAssociationName:
{
Description: User ManagementAssociation Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementAssociations_Get (removed)
Description :  Retrieves the user ManagementAssociation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.OperationsManagement/ManagementAssociations/{managementAssociationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Provider name for the parent resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type for the parent resource ,
Required: True ,
}
string ,
resourceName:
{
Description: Parent resource name. ,
Required: True ,
}
string ,
managementAssociationName:
{
Description: User ManagementAssociation Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementAssociation object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this association. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_ListBySubscription (removed)
Description :  Retrieves the ManagementConfigurations list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationsManagement/ManagementConfigurations
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Management Configuration properties within the subscription. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_CreateOrUpdate (removed)
Description :  Creates or updates the ManagementConfiguration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/ManagementConfigurations/{managementConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
managementConfigurationName:
{
Description: User Management Configuration Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create OMS Solution. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_Delete (removed)
Description :  Deletes the ManagementConfiguration in the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/ManagementConfigurations/{managementConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
managementConfigurationName:
{
Description: User Management Configuration Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagementConfigurations_Get (removed)
Description :  Retrieves the user ManagementConfiguration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/ManagementConfigurations/{managementConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
managementConfigurationName:
{
Description: User Management Configuration Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
properties:
{
Description: Properties for ManagementConfiguration object supported by the OperationsManagement resource provider. ,
Required: False ,
}
{
applicationId:
{
Description: The applicationId of the appliance for this Management. ,
Required: False ,
}
string ,
parentResourceType:
{
Description: The type of the parent resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to run the ARM template ,
Required: True ,
}
[
{
name:
{
Description: name of the parameter. ,
Required: False ,
}
string ,
value:
{
Description: value for the parameter. In Jtoken ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state for the ManagementConfiguration. ,
Required: False ,
}
string ,
template:
{
Description: The Json object containing the ARM template to deploy ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details for a failed request. ,
Required: False ,
}
{
code:
{
Description: The error type. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available OperationsManagement Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.OperationsManagement/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution operations supported by the OperationsManagement resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft OperationsManagement. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}