Package version:

Interface GovernanceAssignments

Interface representing a GovernanceAssignments.

Hierarchy

GovernanceAssignments

Index

Methods

createOrUpdate delete get list

Methods

createOrUpdate

createOrUpdate(scope: string, assessmentName: string, assignmentKey: string, governanceAssignment: GovernanceAssignment, options?: GovernanceAssignmentsCreateOrUpdateOptionalParams): Promise<GovernanceAssignment>
Creates or update a security GovernanceAssignment on the given subscription.
Parameters
- scope: string
  
  Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
- assessmentName: string
  
  The Assessment Key - Unique key for the assessment type
- assignmentKey: string
  
  The security governance assignment key - the assessment key of the required governance assignment
- governanceAssignment: GovernanceAssignment
  
  GovernanceAssignment over a subscription scope
- Optional options: GovernanceAssignmentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<GovernanceAssignment>
- Defined in operationsInterfaces/governanceAssignments.ts:63

delete

delete(scope: string, assessmentName: string, assignmentKey: string, options?: GovernanceAssignmentsDeleteOptionalParams): Promise<void>
Delete a GovernanceAssignment over a given scope
Parameters
- scope: string
  
  Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
- assessmentName: string
  
  The Assessment Key - Unique key for the assessment type
- assignmentKey: string
  
  The security governance assignment key - the assessment key of the required governance assignment
- Optional options: GovernanceAssignmentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/governanceAssignments.ts:80

get

get(scope: string, assessmentName: string, assignmentKey: string, options?: GovernanceAssignmentsGetOptionalParams): Promise<GovernanceAssignment>
Get a specific governanceAssignment for the requested scope by AssignmentKey
Parameters
- scope: string
  
  Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
- assessmentName: string
  
  The Assessment Key - Unique key for the assessment type
- assignmentKey: string
  
  The security governance assignment key - the assessment key of the required governance assignment
- Optional options: GovernanceAssignmentsGetOptionalParams
  
  The options parameters.
Returns Promise<GovernanceAssignment>
- Defined in operationsInterfaces/governanceAssignments.ts:46

list

list(scope: string, assessmentName: string, options?: GovernanceAssignmentsListOptionalParams): PagedAsyncIterableIterator<GovernanceAssignment>
Get security governanceAssignments on all your resources inside a scope
Parameters
- scope: string
  
  Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
- assessmentName: string
  
  The Assessment Key - Unique key for the assessment type
- Optional options: GovernanceAssignmentsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GovernanceAssignment>
- Defined in operationsInterfaces/governanceAssignments.ts:31

Generated using TypeDoc