GovernanceAssignments interface

Interface representing a GovernanceAssignments.

Methods

createOrUpdate(string, string, string, GovernanceAssignment, GovernanceAssignmentsCreateOrUpdateOptionalParams)

Creates or updates a governance assignment on the given subscription.

delete(string, string, string, GovernanceAssignmentsDeleteOptionalParams)

Delete a GovernanceAssignment over a given scope

get(string, string, string, GovernanceAssignmentsGetOptionalParams)

Get a specific governanceAssignment for the requested scope by AssignmentKey

list(string, string, GovernanceAssignmentsListOptionalParams)

Get governance assignments on all of your resources inside a scope

Method Details

createOrUpdate(string, string, string, GovernanceAssignment, GovernanceAssignmentsCreateOrUpdateOptionalParams)

Creates or updates a governance assignment on the given subscription.

function createOrUpdate(scope: string, assessmentName: string, assignmentKey: string, governanceAssignment: GovernanceAssignment, options?: GovernanceAssignmentsCreateOrUpdateOptionalParams): Promise<GovernanceAssignment>

Parameters

scope

string

The scope of the Governance assignments. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

assessmentName

string

The Assessment Key - A unique key for the assessment type

assignmentKey

string

The governance assignment key - the assessment key of the required governance assignment

governanceAssignment
GovernanceAssignment

Governance assignment over a subscription scope

options
GovernanceAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

delete(string, string, string, GovernanceAssignmentsDeleteOptionalParams)

Delete a GovernanceAssignment over a given scope

function delete(scope: string, assessmentName: string, assignmentKey: string, options?: GovernanceAssignmentsDeleteOptionalParams): Promise<void>

Parameters

scope

string

The scope of the Governance assignments. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

assessmentName

string

The Assessment Key - A unique key for the assessment type

assignmentKey

string

The governance assignment key - the assessment key of the required governance assignment

options
GovernanceAssignmentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, GovernanceAssignmentsGetOptionalParams)

Get a specific governanceAssignment for the requested scope by AssignmentKey

function get(scope: string, assessmentName: string, assignmentKey: string, options?: GovernanceAssignmentsGetOptionalParams): Promise<GovernanceAssignment>

Parameters

scope

string

The scope of the Governance assignments. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

assessmentName

string

The Assessment Key - A unique key for the assessment type

assignmentKey

string

The governance assignment key - the assessment key of the required governance assignment

options
GovernanceAssignmentsGetOptionalParams

The options parameters.

Returns

list(string, string, GovernanceAssignmentsListOptionalParams)

Get governance assignments on all of your resources inside a scope

function list(scope: string, assessmentName: string, options?: GovernanceAssignmentsListOptionalParams): PagedAsyncIterableIterator<GovernanceAssignment, GovernanceAssignment[], PageSettings>

Parameters

scope

string

The scope of the Governance assignments. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

assessmentName

string

The Assessment Key - A unique key for the assessment type

options
GovernanceAssignmentsListOptionalParams

The options parameters.

Returns