@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api RemediationsClient
@base https://management.azure.com
@version 2019-07-01
@auth OAuth2
@common_fields {api-version: any # Client Api Version.}
@endpoints 24
@hint download_for_search
@toc providers(6), subscriptions(12), {resourceId}(6)

@group providers
@endpoint POST /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments
@desc Gets all deployments for a remediation at management group scope.
@required {managementGroupsNamespace: any # The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed., managementGroupId: any # Management group ID., remediationName: any # The name of the remediation.}
@optional {$top: any # Maximum number of records to return.}
@returns(200) The retrieved remediation deployments.

@endpoint POST /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel
@desc Cancels a remediation at management group scope.
@required {managementGroupsNamespace: any # The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed., managementGroupId: any # Management group ID., remediationName: any # The name of the remediation.}
@returns(200) The remediation that was canceled.

@endpoint GET /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations
@desc Gets all remediations for the management group.
@required {managementGroupsNamespace: any # The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed., managementGroupId: any # Management group ID.}
@optional {$top: any # Maximum number of records to return., $filter: any # OData filter expression.}
@returns(200) The retrieved remediations.

@endpoint PUT /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Creates or updates a remediation at management group scope.
@required {managementGroupsNamespace: any # The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed., managementGroupId: any # Management group ID., remediationName: any # The name of the remediation., parameters: any # The remediation parameters.}
@returns(200) The updated remediation.
@returns(201) The created remediation.

@endpoint GET /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Gets an existing remediation at management group scope.
@required {managementGroupsNamespace: any # The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed., managementGroupId: any # Management group ID., remediationName: any # The name of the remediation.}
@returns(200) The retrieved remediation.

@endpoint DELETE /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Deletes an existing remediation at management group scope.
@required {managementGroupsNamespace: any # The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed., managementGroupId: any # Management group ID., remediationName: any # The name of the remediation.}
@returns(200) The deleted remediation.
@returns(204) The remediation did not exist.

@endgroup

@group subscriptions
@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments
@desc Gets all deployments for a remediation at subscription scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., remediationName: any # The name of the remediation.}
@optional {$top: any # Maximum number of records to return.}
@returns(200) The retrieved remediation deployments.

@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel
@desc Cancels a remediation at subscription scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., remediationName: any # The name of the remediation.}
@returns(200) The remediation that was canceled.

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations
@desc Gets all remediations for the subscription.
@required {subscriptionId: any # Microsoft Azure subscription ID.}
@optional {$top: any # Maximum number of records to return., $filter: any # OData filter expression.}
@returns(200) The retrieved remediations.

@endpoint PUT /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Creates or updates a remediation at subscription scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., remediationName: any # The name of the remediation., parameters: any # The remediation parameters.}
@returns(200) The updated remediation.
@returns(201) The created remediation.

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Gets an existing remediation at subscription scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., remediationName: any # The name of the remediation.}
@returns(200) The retrieved remediation.

@endpoint DELETE /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Deletes an existing remediation at subscription scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., remediationName: any # The name of the remediation.}
@returns(200) The deleted remediation.
@returns(204) The remediation did not exist.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments
@desc Gets all deployments for a remediation at resource group scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name., remediationName: any # The name of the remediation.}
@optional {$top: any # Maximum number of records to return.}
@returns(200) The retrieved remediation deployments.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel
@desc Cancels a remediation at resource group scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name., remediationName: any # The name of the remediation.}
@returns(200) The remediation that was canceled.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations
@desc Gets all remediations for the subscription.
@required {subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name.}
@optional {$top: any # Maximum number of records to return., $filter: any # OData filter expression.}
@returns(200) The retrieved remediations.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Creates or updates a remediation at resource group scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name., remediationName: any # The name of the remediation., parameters: any # The remediation parameters.}
@returns(200) The updated remediation.
@returns(201) The created remediation.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Gets an existing remediation at resource group scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name., remediationName: any # The name of the remediation.}
@returns(200) The retrieved remediation.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Deletes an existing remediation at resource group scope.
@required {subscriptionId: any # Microsoft Azure subscription ID., resourceGroupName: any # Resource group name., remediationName: any # The name of the remediation.}
@returns(200) The deleted remediation.
@returns(204) The remediation did not exist.

@endgroup

@group {resourceId}
@endpoint POST /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments
@desc Gets all deployments for a remediation at resource scope.
@required {resourceId: any # Resource ID., remediationName: any # The name of the remediation.}
@optional {$top: any # Maximum number of records to return.}
@returns(200) The retrieved remediation deployments.

@endpoint POST /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel
@desc Cancel a remediation at resource scope.
@required {resourceId: any # Resource ID., remediationName: any # The name of the remediation.}
@returns(200) The remediation that was canceled.

@endpoint GET /{resourceId}/providers/Microsoft.PolicyInsights/remediations
@desc Gets all remediations for a resource.
@required {resourceId: any # Resource ID.}
@optional {$top: any # Maximum number of records to return., $filter: any # OData filter expression.}
@returns(200) The retrieved remediations.

@endpoint PUT /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Creates or updates a remediation at resource scope.
@required {resourceId: any # Resource ID., remediationName: any # The name of the remediation., parameters: any # The remediation parameters.}
@returns(200) The updated remediation.
@returns(201) The created remediation.

@endpoint GET /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Gets an existing remediation at resource scope.
@required {resourceId: any # Resource ID., remediationName: any # The name of the remediation.}
@returns(200) The retrieved remediation.

@endpoint DELETE /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}
@desc Deletes an existing remediation at individual resource scope.
@required {resourceId: any # Resource ID., remediationName: any # The name of the remediation.}
@returns(200) The deleted remediation.
@returns(204) The remediation did not exist.

@endgroup

@end