Edit

Get-AzPolicyMetadata

Gets Policy Metadata resources.

Syntax

List (Default)

Get-AzPolicyMetadata
    [-Top <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetByName

Get-AzPolicyMetadata
    -Name <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

The Get-AzPolicyMetadata 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'.

It will include a bit more info about the resource than collection calls.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases: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

The name of the policy metadata resource. Returns additional information about the specified policy metadata resource.

Parameter properties

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

Parameter sets

GetByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Top

Maximum number of records to return.

Parameter properties

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

Parameter sets

List
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.

Outputs

Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.IPolicyMetadata