Skip to content

Latest commit

 

History

History
165 lines (128 loc) · 5.65 KB

azure-policy-check-gate-v0.md

File metadata and controls

165 lines (128 loc) · 5.65 KB
Raw
title description ms.date monikerRange
AzurePolicyCheckGate@0 - Check Azure Policy compliance v0 task
Security and compliance assessment for Azure Policy.
07/02/2024
>=azure-pipelines-2019.1

AzurePolicyCheckGate@0 - Check Azure Policy compliance v0 task

:::moniker range=">=azure-pipelines-2019.1"

Use this task to check the security and compliance assessment for Azure Policy.

:::moniker-end

Syntax

:::moniker range=">=azure-pipelines-2022.1"

# Check Azure Policy compliance v0
# Security and compliance assessment for Azure Policy.
- task: AzurePolicyCheckGate@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    #ResourceGroupName: # string. Resource group. 
    #Resources: # string. Resource name. 
  # Advanced
    #RetryDuration: '00:02:00' # string. Retry duration. Default: 00:02:00.

:::moniker-end

:::moniker range=">=azure-pipelines-2019.1 <=azure-pipelines-2022"

# Check Azure Policy compliance v0
# Security and compliance assessment for Azure Policy.
- task: AzurePolicyCheckGate@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    #ResourceGroupName: # string. Resource group. 
    #Resources: # string. Resource name.

:::moniker-end

Inputs

:::moniker range=">=azure-pipelines-2019.1"

azureSubscription - Azure subscription
Input alias: ConnectedServiceName. string. Required.

Selects the Azure Resource Manager subscription you want to use to enforce the policies.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

ResourceGroupName - Resource group
string.

Provides the resource group name.


:::moniker-end

:::moniker range=">=azure-pipelines-2019.1"

Resources - Resource name
string.

Selects the name of Azure resources for which you want to check the policy compliance.


:::moniker-end

:::moniker range=">=azure-pipelines-2022.1"

RetryDuration - Retry duration
string. Default value: 00:02:00.

The Check Azure Policy compliance task performs an asynchronous On-demand evaluation scan of your compliance data of Azure resources. The call returns a 202 Accepted status while the evaluation is ongoing. The RetryDuration input configures the intervals in which the task retries the REST API call to check for the completion of the policy evaluation. The format is hours:minutes:seconds in the following format: hh:mm:ss.

The default is 00:02:00 (two minutes), which is the minumum interval that may be configured.


:::moniker-end

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

:::moniker range=">=azure-pipelines-2019.1"

None.

:::moniker-end

Remarks

Azure Policy allows you to assess and enforce resource compliance against defined IT policies. Use this task in a gate to identify, analyze and evaluate the security risks, and determine the mitigation measures required to reduce the risks.

Note

Can be used only as a gate. This task is not supported in a build or release pipeline.

:::image type="content" source="media/gates.png" alt-text="Screenshot that shows using the task as a gate in a release pipeline.":::

Requirements

:::moniker range=">=azure-pipelines-2019.1"

Requirement Description
Pipeline types Classic release
Runs on ServerGate
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version All supported agent versions.
Task category Deploy

:::moniker-end