PolicyCmdletBase Class

Definition

Namespace:

Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation

Assembly:

Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll

Base class for policy cmdlets.

public abstract class PolicyCmdletBase : Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.ResourceManagerCmdletBaseWithApiVersion

type PolicyCmdletBase = class
    inherit ResourceManagerCmdletBaseWithApiVersion

Public MustInherit Class PolicyCmdletBase
Inherits ResourceManagerCmdletBaseWithApiVersion

Inheritance

PSCmdlet

AzurePSCmdlet

AzureRMCmdlet

ResourceManagerCmdletBase

ResourceManagerCmdletBaseWithApiVersion

PolicyCmdletBase

Constructors

PolicyCmdletBase()

Fields

_adalListener	(Inherited from AzurePSCmdlet)
_clientRequestId	(Inherited from AzurePSCmdlet)
_fileTimeStampSuffixFormat	(Inherited from AzurePSCmdlet)
_metricHelper	(Inherited from AzurePSCmdlet)
_qosEvent	(Inherited from AzurePSCmdlet)
_serviceClientTracingInterceptor	(Inherited from AzureRMCmdlet)
AUX_HEADER_NAME	(Inherited from AzureRMCmdlet)
AUX_TOKEN_APPEND_CHAR	(Inherited from AzureRMCmdlet)
AUX_TOKEN_PREFIX	(Inherited from AzureRMCmdlet)
BuiltinFilterParameterSet
CustomFilterParameterSet
DefaultParameterSet
EnqueueDebugKey	(Inherited from AzureRMCmdlet)
IdParameterSet	Parameter set names
IncludeDescendentParameterSet
InputObjectParameterSet
ManagementGroupNameParameterSet
MAX_NUMBER_OF_TOKENS_ALLOWED_IN_AUX_HEADER	(Inherited from AzureRMCmdlet)
NameParameterSet
PolicyParameterIdObjectParameterSet
PolicyParameterIdStringParameterSet
PolicyParameterNameObjectParameterSet
PolicyParameterNameStringParameterSet
PolicyParameterObjectParameterSet
PolicyParameterStringParameterSet
PolicySetParameterObjectParameterSet
PolicySetParameterStringParameterSet
PolicyTypeFilterFormat	The policy type OData filter format
SubscriptionIdParameterSet
WriteDebugKey	(Inherited from AzureRMCmdlet)
WriteInformationKey	(Inherited from AzureRMCmdlet)
WriteVerboseKey	(Inherited from AzureRMCmdlet)
WriteWarningKey	(Inherited from AzureRMCmdlet)

Properties

_dataCollectionProfile	(Inherited from AzurePSCmdlet)
_matchers	(Inherited from AzurePSCmdlet)
ApiVersion	Gets or sets the API version. (Inherited from ResourceManagerCmdletBaseWithApiVersion)
AsJobDynamicParameters	(Inherited from AzurePSCmdlet)
CancellationToken	Gets the cancellation source. (Inherited from ResourceManagerCmdletBase)
DataCollectionWarning	(Inherited from AzureRMCmdlet)
DebugMessages	(Inherited from AzurePSCmdlet)
DefaultContext	(Inherited from AzureRMCmdlet)
DefaultProfile	(Inherited from AzureRMCmdlet)
ImplementationBackgroundJobDescription	(Inherited from AzurePSCmdlet)
IsErrorMetricEnabled	(Inherited from AzurePSCmdlet)
IsUsageMetricEnabled	(Inherited from AzurePSCmdlet)
ModuleName	(Inherited from AzurePSCmdlet)
ModuleVersion	(Inherited from AzurePSCmdlet)
NewResourceManagerSdkClient	Gets or sets the resource manager sdk client (Inherited from ResourceManagerCmdletBase)
Pre	Gets or sets the switch that indicates if pre-release API version should be considered. (Inherited from ResourceManagerCmdletBase)
PSVersion	Obsolete. (Inherited from AzurePSCmdlet)
ResourceManagerSdkClient	Gets or sets the resource manager sdk client (Inherited from ResourceManagerCmdletBase)
SessionState	(Inherited from AzurePSCmdlet)
SubscriptionSdkClient	Gets or sets the subscription sdk client (Inherited from ResourceManagerCmdletBase)

Methods

AddDebuggingFilter(Regex)	(Inherited from AzurePSCmdlet)
BeginProcessing()	The BeginProcessing method. (Inherited from ResourceManagerCmdletBase)
CheckIfInteractive()	(Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action)	(Inherited from AzureRMCmdlet)
ConfirmAction(Boolean, String, String, String, Action, Func<Boolean>)	(Inherited from AzurePSCmdlet)
ConfirmAction(String, String, Action)	(Inherited from AzurePSCmdlet)
ConfirmResourceAction(String, Boolean, String, String, Action, Func<Boolean>)	(Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, Action)	(Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, Boolean, String, String, Action, Func<Boolean>)	(Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, String, Action)	(Inherited from AzureRMCmdlet)
ConstructPSObject(String, Object[])	(Inherited from AzurePSCmdlet)
CurrentPath()	(Inherited from AzurePSCmdlet)
DetermineApiVersion(String, Nullable<Boolean>)	Determines the API version. (Inherited from ResourceManagerCmdletBaseWithApiVersion)
DetermineApiVersion(String, String, Nullable<Boolean>)	Determines the API version. (Inherited from ResourceManagerCmdletBaseWithApiVersion)
DetermineParameterSetName()	Determines the parameter set name. (Inherited from ResourceManagerCmdletBase)
Dispose()	(Inherited from AzurePSCmdlet)
Dispose(Boolean)	(Inherited from AzureRMCmdlet)
EndProcessing()	The EndProcessing method. (Inherited from ResourceManagerCmdletBase)
ExecuteCmdlet()	The ProcessRecord method. (Inherited from ResourceManagerCmdletBase)
FlushInitializationWarnings()	(Inherited from AzurePSCmdlet)
GetArrayFromParameter(String, String)	Gets a JArray from a parameter value
GetAuxilaryAuthHeaderFromResourceIds(List<String>)	(Inherited from AzureRMCmdlet)
GetAuxiliaryAuthHeaderFromTenantIds(IEnumerable<String>)	(Inherited from AzureRMCmdlet)
GetDynamicParameters()	(Inherited from AzureRMCmdlet)
GetExistingResource(String, String)	Gets a resource.
GetFilteredOutputPolicyDefinitions(PolicyCmdletBase+ListFilter, JToken[])	Converts the resource object collection to a filtered PsPolicyDefinition array.
GetFilteredOutputPolicySetDefinitions(PolicyCmdletBase+ListFilter, JObject[])	Converts the resource object collection to a filtered PsPolicySetDefinition array.
GetListFilter(Boolean, Boolean)	Validate and convert input switches into filter type enum
GetNextLink<TType>(String)	Gets the next set of resources using the nextLink
GetObjectFromParameter(String, String)	Gets a JObject from a parameter value
GetOutputPolicyAssignments(JToken[])	Converts the resource object collection to a PsPolicyAssignment collection.
GetOutputPolicyDefinitions(JToken[])	Converts the resource object collection to a PsPolicyDefinition collection.
GetOutputPolicyExemptions(JToken[])	Converts the resource object collection to a PsPolicyExemption collection.
GetOutputPolicySetDefinitions(JToken[])	Converts the resource object collection to a PsPolicySetDefinition collection.
GetParameters(String, Hashtable)	Resolve given input parameters into JSON parameter object for put
GetPolicyArtifactFullyQualifiedId(String, String, String)	Gets the resource Id from the supplied PowerShell parameters.
GetResourcesClient()	Gets a new instance of the ResourceManagerRestRestClient. (Inherited from ResourceManagerCmdletBase)
InitDebuggingFilter()	(Inherited from AzurePSCmdlet)
InitializeQosEvent()	(Inherited from AzureRMCmdlet)
IsDataCollectionAllowed()	(Inherited from AzurePSCmdlet)
IsTerminatingError(Exception)	(Inherited from AzurePSCmdlet)
IsVerbose()	(Inherited from AzurePSCmdlet)
LoadModuleVersion(String, Boolean)	(Inherited from AzurePSCmdlet)
LogCmdletEndInvocationInfo()	(Inherited from AzureRMCmdlet)
LogCmdletStartInvocationInfo()	(Inherited from AzureRMCmdlet)
LogQosEvent()	(Inherited from AzurePSCmdlet)
MakePolicyDefinitionId(String, Nullable<Guid>, String)	Returns the policy definition resource Id given management group name and/or subscription id and/or policy definition name
MakePolicySetDefinitionId(String, Nullable<Guid>, String)	Returns the policy set definition resource Id given management group name and/or subscription id and/or policy set definition name
OnBeginProcessing()	When overridden, allows child classes to be called when the BeginProcessing method is invoked. (Inherited from ResourceManagerCmdletBase)
OnEndProcessing()	When overridden, allows child classes to be called when the EndProcessing method is invoked. (Inherited from ResourceManagerCmdletBase)
OnProcessRecord()	When overridden, allows child classes to be called when the ProcessRecord method is invoked. (Inherited from ResourceManagerCmdletBase)
OnStopProcessing()	When overridden, allows child classes to be called when the StopProcessing method is invoked. (Inherited from ResourceManagerCmdletBase)
ProcessRecord()	(Inherited from AzurePSCmdlet)
RegisterDynamicParameters(RuntimeDefinedParameterDictionary)	(Inherited from AzurePSCmdlet)
RequireDefaultContext()	(Inherited from AzureRMCmdlet)
ResolveUserPath(String)	(Inherited from AzurePSCmdlet)
ResolveUserPath(String[])	(Inherited from AzurePSCmdlet)
SafeWriteOutputPSObject(String, Object[])	(Inherited from AzurePSCmdlet)
SetBackgroundJobDescription(String)	(Inherited from AzurePSCmdlet)
SetupDebuggingTraces()	(Inherited from AzureRMCmdlet)
SetupHttpClientPipeline()	(Inherited from AzurePSCmdlet)
ShouldGetByName(String, String)	(Inherited from AzureRMCmdlet)
ShouldListByResourceGroup(String, String)	(Inherited from AzureRMCmdlet)
ShouldListBySubscription(String, String)	(Inherited from AzureRMCmdlet)
StopProcessing()	The StopProcessing method. (Inherited from ResourceManagerCmdletBase)
SubResourceWildcardFilter<T>(String, IEnumerable<T>)	(Inherited from AzureRMCmdlet)
TearDownDebuggingTraces()	(Inherited from AzureRMCmdlet)
TearDownHttpClientPipeline()	(Inherited from AzurePSCmdlet)
ThrowTerminatingError(ErrorRecord)	(Inherited from AzurePSCmdlet)
TopLevelWildcardFilter<T>(String, String, IEnumerable<T>)	(Inherited from AzureRMCmdlet)
TryConvertAndWriteObject(String)	Writes the object (Inherited from ResourceManagerCmdletBase)
TryConvertToResourceAndWriteObject(String)	Writes the object (Inherited from ResourceManagerCmdletBase)
TryGetDefaultContext(IAzureContext)	(Inherited from AzureRMCmdlet)
WriteCommandDetail(String)	(Inherited from AzurePSCmdlet)
WriteDebug(String)	(Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String)	(Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String, Object[])	(Inherited from AzurePSCmdlet)
WriteError(ErrorRecord)	(Inherited from AzurePSCmdlet)
WriteErrorWithTimestamp(String)	(Inherited from AzurePSCmdlet)
WriteExceptionError(Exception)	(Inherited from AzurePSCmdlet)
WriteInformation(Object, String[])	(Inherited from AzurePSCmdlet)
WriteInformation(String, Nullable<Boolean>)	(Inherited from AzurePSCmdlet)
WriteInformationWithTimestamp(String)	(Inherited from AzurePSCmdlet)
WriteInitializationWarnings(String)	(Inherited from AzurePSCmdlet)
WriteObject(JToken)	Writes a Newtonsoft.Json.Linq.JToken object as a PSObject. (Inherited from ResourceManagerCmdletBase)
WriteObject(Object)	(Inherited from AzurePSCmdlet)
WriteObject(Object, Boolean)	(Inherited from AzurePSCmdlet)
WriteProgress(ProgressRecord)	(Inherited from AzurePSCmdlet)
WriteSurvey()	(Inherited from AzurePSCmdlet)
WriteVerbose(String)	(Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String)	(Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String, Object[])	(Inherited from AzurePSCmdlet)
WriteWarning(String)	(Inherited from AzurePSCmdlet)
WriteWarningWithTimestamp(String)	(Inherited from AzurePSCmdlet)

Extension Methods

DisableDataCollection(AzurePSCmdlet)

EnableDataCollection(AzurePSCmdlet)