Edit

Share via


Get-AzPolicyMetadata

Gets Policy Metadata resources

Syntax

Default (Default)

Get-AzPolicyMetadata
    [-Name <String>]
    [-Top <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzPolicyRemediation cmdlet gets all policy metadata resources or a particular policy metadata resource.

Examples

Example 1: Get all policy metadata resources

Get-AzPolicyMetadata

This command gets all policy metadata resources

Example 2: Get a collection of 10 policy metadata resources

Get-AzPolicyMetadata -Top 10

This command gets a collection of 10 policy metadata resources

Example 3: Get a single policy metadata resource with the name 'ACF1348'

Get-AzPolicyMetadata -Name ACF1348

This command gets a single policy metadata resource with the name 'ACF1348'

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Top

Maximum number of policy metadata resources to return.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

PSPolicyMetadata