GovernanceRules interface
Interface representing a GovernanceRules.
Methods
| begin |
Delete a Governance rule over a given scope |
| begin |
Delete a Governance rule over a given scope |
| begin |
Execute a governance rule |
| begin |
Execute a governance rule |
| create |
Creates or updates a governance rule over a given scope |
| get(string, string, Governance |
Get a specific governance rule for the requested scope by ruleId |
| list(string, Governance |
Get a list of all relevant governance rules over a scope |
| operation |
Get governance rules long run operation result for the requested scope by ruleId and operationId |
Method Details
beginDelete(string, string, GovernanceRulesDeleteOptionalParams)
Delete a Governance rule over a given scope
function beginDelete(scope: string, ruleId: string, options?: GovernanceRulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
- ruleId
-
string
The governance rule key - unique key for the standard governance rule (GUID)
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, GovernanceRulesDeleteOptionalParams)
Delete a Governance rule over a given scope
function beginDeleteAndWait(scope: string, ruleId: string, options?: GovernanceRulesDeleteOptionalParams): Promise<void>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
- ruleId
-
string
The governance rule key - unique key for the standard governance rule (GUID)
The options parameters.
Returns
Promise<void>
beginExecute(string, string, GovernanceRulesExecuteOptionalParams)
Execute a governance rule
function beginExecute(scope: string, ruleId: string, options?: GovernanceRulesExecuteOptionalParams): Promise<SimplePollerLike<OperationState<GovernanceRulesExecuteHeaders>, GovernanceRulesExecuteHeaders>>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
- ruleId
-
string
The governance rule key - unique key for the standard governance rule (GUID)
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<GovernanceRulesExecuteHeaders>, GovernanceRulesExecuteHeaders>>
beginExecuteAndWait(string, string, GovernanceRulesExecuteOptionalParams)
Execute a governance rule
function beginExecuteAndWait(scope: string, ruleId: string, options?: GovernanceRulesExecuteOptionalParams): Promise<GovernanceRulesExecuteHeaders>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
- ruleId
-
string
The governance rule key - unique key for the standard governance rule (GUID)
The options parameters.
Returns
Promise<GovernanceRulesExecuteHeaders>
createOrUpdate(string, string, GovernanceRule, GovernanceRulesCreateOrUpdateOptionalParams)
Creates or updates a governance rule over a given scope
function createOrUpdate(scope: string, ruleId: string, governanceRule: GovernanceRule, options?: GovernanceRulesCreateOrUpdateOptionalParams): Promise<GovernanceRule>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
- ruleId
-
string
The governance rule key - unique key for the standard governance rule (GUID)
- governanceRule
- GovernanceRule
Governance rule over a given scope
The options parameters.
Returns
Promise<GovernanceRule>
get(string, string, GovernanceRulesGetOptionalParams)
Get a specific governance rule for the requested scope by ruleId
function get(scope: string, ruleId: string, options?: GovernanceRulesGetOptionalParams): Promise<GovernanceRule>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
- ruleId
-
string
The governance rule key - unique key for the standard governance rule (GUID)
- options
- GovernanceRulesGetOptionalParams
The options parameters.
Returns
Promise<GovernanceRule>
list(string, GovernanceRulesListOptionalParams)
Get a list of all relevant governance rules over a scope
function list(scope: string, options?: GovernanceRulesListOptionalParams): PagedAsyncIterableIterator<GovernanceRule, GovernanceRule[], PageSettings>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
The options parameters.
Returns
operationResults(string, string, string, GovernanceRulesOperationResultsOptionalParams)
Get governance rules long run operation result for the requested scope by ruleId and operationId
function operationResults(scope: string, ruleId: string, operationId: string, options?: GovernanceRulesOperationResultsOptionalParams): Promise<OperationResultAutoGenerated>Parameters
- scope
-
string
The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
- ruleId
-
string
The governance rule key - unique key for the standard governance rule (GUID)
- operationId
-
string
The governance rule long running operation unique key
The options parameters.
Returns
Promise<OperationResultAutoGenerated>
Azure SDK for JavaScript