Share via

Remediations interface

  • Reference
Package:
@azure/arm-policyinsights

Interface representing a Remediations.

Methods

cancelAtManagementGroup(string, string, RemediationsCancelAtManagementGroupOptionalParams)

Cancels a remediation at management group scope.
cancelAtResource(string, string, RemediationsCancelAtResourceOptionalParams)

Cancel a remediation at resource scope.
cancelAtResourceGroup(string, string, RemediationsCancelAtResourceGroupOptionalParams)

Cancels a remediation at resource group scope.
cancelAtSubscription(string, RemediationsCancelAtSubscriptionOptionalParams)

Cancels a remediation at subscription scope.
createOrUpdateAtManagementGroup(string, string, Remediation, RemediationsCreateOrUpdateAtManagementGroupOptionalParams)

Creates or updates a remediation at management group scope.
createOrUpdateAtResource(string, string, Remediation, RemediationsCreateOrUpdateAtResourceOptionalParams)

Creates or updates a remediation at resource scope.
createOrUpdateAtResourceGroup(string, string, Remediation, RemediationsCreateOrUpdateAtResourceGroupOptionalParams)

Creates or updates a remediation at resource group scope.
createOrUpdateAtSubscription(string, Remediation, RemediationsCreateOrUpdateAtSubscriptionOptionalParams)

Creates or updates a remediation at subscription scope.
deleteAtManagementGroup(string, string, RemediationsDeleteAtManagementGroupOptionalParams)

Deletes an existing remediation at management group scope.
deleteAtResource(string, string, RemediationsDeleteAtResourceOptionalParams)

Deletes an existing remediation at individual resource scope.
deleteAtResourceGroup(string, string, RemediationsDeleteAtResourceGroupOptionalParams)

Deletes an existing remediation at resource group scope.
deleteAtSubscription(string, RemediationsDeleteAtSubscriptionOptionalParams)

Deletes an existing remediation at subscription scope.
getAtManagementGroup(string, string, RemediationsGetAtManagementGroupOptionalParams)

Gets an existing remediation at management group scope.
getAtResource(string, string, RemediationsGetAtResourceOptionalParams)

Gets an existing remediation at resource scope.
getAtResourceGroup(string, string, RemediationsGetAtResourceGroupOptionalParams)

Gets an existing remediation at resource group scope.
getAtSubscription(string, RemediationsGetAtSubscriptionOptionalParams)

Gets an existing remediation at subscription scope.
listDeploymentsAtManagementGroup(string, string, RemediationsListDeploymentsAtManagementGroupOptionalParams)

Gets all deployments for a remediation at management group scope.
listDeploymentsAtResource(string, string, RemediationsListDeploymentsAtResourceOptionalParams)

Gets all deployments for a remediation at resource scope.
listDeploymentsAtResourceGroup(string, string, RemediationsListDeploymentsAtResourceGroupOptionalParams)

Gets all deployments for a remediation at resource group scope.
listDeploymentsAtSubscription(string, RemediationsListDeploymentsAtSubscriptionOptionalParams)

Gets all deployments for a remediation at subscription scope.
listForManagementGroup(string, RemediationsListForManagementGroupOptionalParams)

Gets all remediations for the management group.
listForResource(string, RemediationsListForResourceOptionalParams)

Gets all remediations for a resource.
listForResourceGroup(string, RemediationsListForResourceGroupOptionalParams)

Gets all remediations for the subscription.
listForSubscription(RemediationsListForSubscriptionOptionalParams)

Gets all remediations for the subscription.

Method Details

cancelAtManagementGroup(string, string, RemediationsCancelAtManagementGroupOptionalParams)

Cancels a remediation at management group scope.

function cancelAtManagementGroup(managementGroupId: string, remediationName: string, options?: RemediationsCancelAtManagementGroupOptionalParams): Promise<Remediation>

Parameters

managementGroupId

string

Management group ID.

remediationName

string

The name of the remediation.

options
RemediationsCancelAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

cancelAtResource(string, string, RemediationsCancelAtResourceOptionalParams)

Cancel a remediation at resource scope.

function cancelAtResource(resourceId: string, remediationName: string, options?: RemediationsCancelAtResourceOptionalParams): Promise<Remediation>

Parameters

resourceId

string

Resource ID.

remediationName

string

The name of the remediation.

options
RemediationsCancelAtResourceOptionalParams

The options parameters.

Returns

Promise<Remediation>

cancelAtResourceGroup(string, string, RemediationsCancelAtResourceGroupOptionalParams)

Cancels a remediation at resource group scope.

function cancelAtResourceGroup(resourceGroupName: string, remediationName: string, options?: RemediationsCancelAtResourceGroupOptionalParams): Promise<Remediation>

Parameters

resourceGroupName

string

Resource group name.

remediationName

string

The name of the remediation.

options
RemediationsCancelAtResourceGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

cancelAtSubscription(string, RemediationsCancelAtSubscriptionOptionalParams)

Cancels a remediation at subscription scope.

function cancelAtSubscription(remediationName: string, options?: RemediationsCancelAtSubscriptionOptionalParams): Promise<Remediation>

Parameters

remediationName

string

The name of the remediation.

options
RemediationsCancelAtSubscriptionOptionalParams

The options parameters.

Returns

Promise<Remediation>

createOrUpdateAtManagementGroup(string, string, Remediation, RemediationsCreateOrUpdateAtManagementGroupOptionalParams)

Creates or updates a remediation at management group scope.

function createOrUpdateAtManagementGroup(managementGroupId: string, remediationName: string, parameters: Remediation, options?: RemediationsCreateOrUpdateAtManagementGroupOptionalParams): Promise<Remediation>

Parameters

managementGroupId

string

Management group ID.

remediationName

string

The name of the remediation.

parameters
Remediation

The remediation parameters.

options
RemediationsCreateOrUpdateAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

createOrUpdateAtResource(string, string, Remediation, RemediationsCreateOrUpdateAtResourceOptionalParams)

Creates or updates a remediation at resource scope.

function createOrUpdateAtResource(resourceId: string, remediationName: string, parameters: Remediation, options?: RemediationsCreateOrUpdateAtResourceOptionalParams): Promise<Remediation>

Parameters

resourceId

string

Resource ID.

remediationName

string

The name of the remediation.

parameters
Remediation

The remediation parameters.

options
RemediationsCreateOrUpdateAtResourceOptionalParams

The options parameters.

Returns

Promise<Remediation>

createOrUpdateAtResourceGroup(string, string, Remediation, RemediationsCreateOrUpdateAtResourceGroupOptionalParams)

Creates or updates a remediation at resource group scope.

function createOrUpdateAtResourceGroup(resourceGroupName: string, remediationName: string, parameters: Remediation, options?: RemediationsCreateOrUpdateAtResourceGroupOptionalParams): Promise<Remediation>

Parameters

resourceGroupName

string

Resource group name.

remediationName

string

The name of the remediation.

parameters
Remediation

The remediation parameters.

options
RemediationsCreateOrUpdateAtResourceGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

createOrUpdateAtSubscription(string, Remediation, RemediationsCreateOrUpdateAtSubscriptionOptionalParams)

Creates or updates a remediation at subscription scope.

function createOrUpdateAtSubscription(remediationName: string, parameters: Remediation, options?: RemediationsCreateOrUpdateAtSubscriptionOptionalParams): Promise<Remediation>

Parameters

remediationName

string

The name of the remediation.

parameters
Remediation

The remediation parameters.

options
RemediationsCreateOrUpdateAtSubscriptionOptionalParams

The options parameters.

Returns

Promise<Remediation>

deleteAtManagementGroup(string, string, RemediationsDeleteAtManagementGroupOptionalParams)

Deletes an existing remediation at management group scope.

function deleteAtManagementGroup(managementGroupId: string, remediationName: string, options?: RemediationsDeleteAtManagementGroupOptionalParams): Promise<Remediation>

Parameters

managementGroupId

string

Management group ID.

remediationName

string

The name of the remediation.

options
RemediationsDeleteAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

deleteAtResource(string, string, RemediationsDeleteAtResourceOptionalParams)

Deletes an existing remediation at individual resource scope.

function deleteAtResource(resourceId: string, remediationName: string, options?: RemediationsDeleteAtResourceOptionalParams): Promise<Remediation>

Parameters

resourceId

string

Resource ID.

remediationName

string

The name of the remediation.

options
RemediationsDeleteAtResourceOptionalParams

The options parameters.

Returns

Promise<Remediation>

deleteAtResourceGroup(string, string, RemediationsDeleteAtResourceGroupOptionalParams)

Deletes an existing remediation at resource group scope.

function deleteAtResourceGroup(resourceGroupName: string, remediationName: string, options?: RemediationsDeleteAtResourceGroupOptionalParams): Promise<Remediation>

Parameters

resourceGroupName

string

Resource group name.

remediationName

string

The name of the remediation.

options
RemediationsDeleteAtResourceGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

deleteAtSubscription(string, RemediationsDeleteAtSubscriptionOptionalParams)

Deletes an existing remediation at subscription scope.

function deleteAtSubscription(remediationName: string, options?: RemediationsDeleteAtSubscriptionOptionalParams): Promise<Remediation>

Parameters

remediationName

string

The name of the remediation.

options
RemediationsDeleteAtSubscriptionOptionalParams

The options parameters.

Returns

Promise<Remediation>

getAtManagementGroup(string, string, RemediationsGetAtManagementGroupOptionalParams)

Gets an existing remediation at management group scope.

function getAtManagementGroup(managementGroupId: string, remediationName: string, options?: RemediationsGetAtManagementGroupOptionalParams): Promise<Remediation>

Parameters

managementGroupId

string

Management group ID.

remediationName

string

The name of the remediation.

options
RemediationsGetAtManagementGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

getAtResource(string, string, RemediationsGetAtResourceOptionalParams)

Gets an existing remediation at resource scope.

function getAtResource(resourceId: string, remediationName: string, options?: RemediationsGetAtResourceOptionalParams): Promise<Remediation>

Parameters

resourceId

string

Resource ID.

remediationName

string

The name of the remediation.

options
RemediationsGetAtResourceOptionalParams

The options parameters.

Returns

Promise<Remediation>

getAtResourceGroup(string, string, RemediationsGetAtResourceGroupOptionalParams)

Gets an existing remediation at resource group scope.

function getAtResourceGroup(resourceGroupName: string, remediationName: string, options?: RemediationsGetAtResourceGroupOptionalParams): Promise<Remediation>

Parameters

resourceGroupName

string

Resource group name.

remediationName

string

The name of the remediation.

options
RemediationsGetAtResourceGroupOptionalParams

The options parameters.

Returns

Promise<Remediation>

getAtSubscription(string, RemediationsGetAtSubscriptionOptionalParams)

Gets an existing remediation at subscription scope.

function getAtSubscription(remediationName: string, options?: RemediationsGetAtSubscriptionOptionalParams): Promise<Remediation>

Parameters

remediationName

string

The name of the remediation.

options
RemediationsGetAtSubscriptionOptionalParams

The options parameters.

Returns

Promise<Remediation>

listDeploymentsAtManagementGroup(string, string, RemediationsListDeploymentsAtManagementGroupOptionalParams)

Gets all deployments for a remediation at management group scope.

function listDeploymentsAtManagementGroup(managementGroupId: string, remediationName: string, options?: RemediationsListDeploymentsAtManagementGroupOptionalParams): PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

Parameters

managementGroupId

string

Management group ID.

remediationName

string

The name of the remediation.

options
RemediationsListDeploymentsAtManagementGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

listDeploymentsAtResource(string, string, RemediationsListDeploymentsAtResourceOptionalParams)

Gets all deployments for a remediation at resource scope.

function listDeploymentsAtResource(resourceId: string, remediationName: string, options?: RemediationsListDeploymentsAtResourceOptionalParams): PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

Parameters

resourceId

string

Resource ID.

remediationName

string

The name of the remediation.

options
RemediationsListDeploymentsAtResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

listDeploymentsAtResourceGroup(string, string, RemediationsListDeploymentsAtResourceGroupOptionalParams)

Gets all deployments for a remediation at resource group scope.

function listDeploymentsAtResourceGroup(resourceGroupName: string, remediationName: string, options?: RemediationsListDeploymentsAtResourceGroupOptionalParams): PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

Parameters

resourceGroupName

string

Resource group name.

remediationName

string

The name of the remediation.

options
RemediationsListDeploymentsAtResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

listDeploymentsAtSubscription(string, RemediationsListDeploymentsAtSubscriptionOptionalParams)

Gets all deployments for a remediation at subscription scope.

function listDeploymentsAtSubscription(remediationName: string, options?: RemediationsListDeploymentsAtSubscriptionOptionalParams): PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

Parameters

remediationName

string

The name of the remediation.

options
RemediationsListDeploymentsAtSubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RemediationDeployment, RemediationDeployment[], PageSettings>

listForManagementGroup(string, RemediationsListForManagementGroupOptionalParams)

Gets all remediations for the management group.

function listForManagementGroup(managementGroupId: string, options?: RemediationsListForManagementGroupOptionalParams): PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>

Parameters

managementGroupId

string

Management group ID.

options
RemediationsListForManagementGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>

listForResource(string, RemediationsListForResourceOptionalParams)

Gets all remediations for a resource.

function listForResource(resourceId: string, options?: RemediationsListForResourceOptionalParams): PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>

Parameters

resourceId

string

Resource ID.

options
RemediationsListForResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>

listForResourceGroup(string, RemediationsListForResourceGroupOptionalParams)

Gets all remediations for the subscription.

function listForResourceGroup(resourceGroupName: string, options?: RemediationsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>

Parameters

resourceGroupName

string

Resource group name.

options
RemediationsListForResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>

listForSubscription(RemediationsListForSubscriptionOptionalParams)

Gets all remediations for the subscription.

function listForSubscription(options?: RemediationsListForSubscriptionOptionalParams): PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>

Parameters

options
RemediationsListForSubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Remediation, Remediation[], PageSettings>