armpolicy

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2021 License: MIT Imports: 16 Imported by: 18

README

Azure Resource Policy Module for Go

PkgGoDev

The armpolicy module provides operations for working with Azure Resource Policy.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Resource Policy module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armpolicy

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Resource Policy. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Resource Policy modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armpolicy.NewPolicyDefinitionsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armpolicy.NewPolicyDefinitionsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Resource Policy label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alias

type Alias struct {
	// The default path for an alias.
	DefaultPath *string `json:"defaultPath,omitempty"`

	// The default pattern for an alias.
	DefaultPattern *AliasPattern `json:"defaultPattern,omitempty"`

	// The alias name.
	Name *string `json:"name,omitempty"`

	// The paths for an alias.
	Paths []*AliasPath `json:"paths,omitempty"`

	// The type of the alias.
	Type *AliasType `json:"type,omitempty"`

	// READ-ONLY; The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata
	DefaultMetadata *AliasPathMetadata `json:"defaultMetadata,omitempty" azure:"ro"`
}

Alias - The alias type.

func (Alias) MarshalJSON

func (a Alias) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Alias.

type AliasPath

type AliasPath struct {
	// The API versions.
	APIVersions []*string `json:"apiVersions,omitempty"`

	// The path of an alias.
	Path *string `json:"path,omitempty"`

	// The pattern for an alias path.
	Pattern *AliasPattern `json:"pattern,omitempty"`

	// READ-ONLY; The metadata of the alias path. If missing, fall back to the default metadata of the alias.
	Metadata *AliasPathMetadata `json:"metadata,omitempty" azure:"ro"`
}

AliasPath - The type of the paths for alias.

func (AliasPath) MarshalJSON

func (a AliasPath) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AliasPath.

type AliasPathAttributes

type AliasPathAttributes string

AliasPathAttributes - The attributes of the token that the alias path is referring to.

const (
	// AliasPathAttributesModifiable - The token that the alias path is referring to is modifiable by policies with 'modify' effect.
	AliasPathAttributesModifiable AliasPathAttributes = "Modifiable"
	// AliasPathAttributesNone - The token that the alias path is referring to has no attributes.
	AliasPathAttributesNone AliasPathAttributes = "None"
)

func PossibleAliasPathAttributesValues

func PossibleAliasPathAttributesValues() []AliasPathAttributes

PossibleAliasPathAttributesValues returns the possible values for the AliasPathAttributes const type.

func (AliasPathAttributes) ToPtr

ToPtr returns a *AliasPathAttributes pointing to the current value.

type AliasPathMetadata

type AliasPathMetadata struct {
	// READ-ONLY; The attributes of the token that the alias path is referring to.
	Attributes *AliasPathAttributes `json:"attributes,omitempty" azure:"ro"`

	// READ-ONLY; The type of the token that the alias path is referring to.
	Type *AliasPathTokenType `json:"type,omitempty" azure:"ro"`
}

type AliasPathTokenType

type AliasPathTokenType string

AliasPathTokenType - The type of the token that the alias path is referring to.

const (
	// AliasPathTokenTypeAny - The token type can be anything.
	AliasPathTokenTypeAny AliasPathTokenType = "Any"
	// AliasPathTokenTypeArray - The token type is array.
	AliasPathTokenTypeArray AliasPathTokenType = "Array"
	// AliasPathTokenTypeBoolean - The token type is boolean.
	AliasPathTokenTypeBoolean AliasPathTokenType = "Boolean"
	// AliasPathTokenTypeInteger - The token type is integer.
	AliasPathTokenTypeInteger AliasPathTokenType = "Integer"
	// AliasPathTokenTypeNotSpecified - The token type is not specified.
	AliasPathTokenTypeNotSpecified AliasPathTokenType = "NotSpecified"
	// AliasPathTokenTypeNumber - The token type is number.
	AliasPathTokenTypeNumber AliasPathTokenType = "Number"
	// AliasPathTokenTypeObject - The token type is object.
	AliasPathTokenTypeObject AliasPathTokenType = "Object"
	// AliasPathTokenTypeString - The token type is string.
	AliasPathTokenTypeString AliasPathTokenType = "String"
)

func PossibleAliasPathTokenTypeValues

func PossibleAliasPathTokenTypeValues() []AliasPathTokenType

PossibleAliasPathTokenTypeValues returns the possible values for the AliasPathTokenType const type.

func (AliasPathTokenType) ToPtr

ToPtr returns a *AliasPathTokenType pointing to the current value.

type AliasPattern

type AliasPattern struct {
	// The alias pattern phrase.
	Phrase *string `json:"phrase,omitempty"`

	// The type of alias pattern
	Type *AliasPatternType `json:"type,omitempty"`

	// The alias pattern variable.
	Variable *string `json:"variable,omitempty"`
}

AliasPattern - The type of the pattern for an alias path.

type AliasPatternType

type AliasPatternType string

AliasPatternType - The type of alias pattern

const (
	// AliasPatternTypeNotSpecified - NotSpecified is not allowed.
	AliasPatternTypeNotSpecified AliasPatternType = "NotSpecified"
	// AliasPatternTypeExtract - Extract is the only allowed value.
	AliasPatternTypeExtract AliasPatternType = "Extract"
)

func PossibleAliasPatternTypeValues

func PossibleAliasPatternTypeValues() []AliasPatternType

PossibleAliasPatternTypeValues returns the possible values for the AliasPatternType const type.

func (AliasPatternType) ToPtr

ToPtr returns a *AliasPatternType pointing to the current value.

type AliasType

type AliasType string

AliasType - The type of the alias.

const (
	// AliasTypeNotSpecified - Alias type is unknown (same as not providing alias type).
	AliasTypeNotSpecified AliasType = "NotSpecified"
	// AliasTypePlainText - Alias value is not secret.
	AliasTypePlainText AliasType = "PlainText"
	// AliasTypeMask - Alias value is secret.
	AliasTypeMask AliasType = "Mask"
)

func PossibleAliasTypeValues

func PossibleAliasTypeValues() []AliasType

PossibleAliasTypeValues returns the possible values for the AliasType const type.

func (AliasType) ToPtr

func (c AliasType) ToPtr() *AliasType

ToPtr returns a *AliasType pointing to the current value.

type CloudError

type CloudError struct {

	// Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response
	// format.)
	InnerError *ErrorResponse `json:"error,omitempty"`
	// contains filtered or unexported fields
}

CloudError - An error response from a policy operation. Implements the error and azcore.HTTPResponse interfaces.

func (CloudError) Error

func (e CloudError) Error() string

Error implements the error interface for type CloudError. The contents of the error text are not contractual and subject to change.

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

func (CreatedByType) ToPtr

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

type DataEffect

type DataEffect struct {
	// The data effect details schema.
	DetailsSchema map[string]interface{} `json:"detailsSchema,omitempty"`

	// The data effect name.
	Name *string `json:"name,omitempty"`
}

DataEffect - The data effect definition.

type DataManifestCustomResourceFunctionDefinition

type DataManifestCustomResourceFunctionDefinition struct {
	// A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01').
	AllowCustomProperties *bool `json:"allowCustomProperties,omitempty"`

	// The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported
	DefaultProperties []*string `json:"defaultProperties,omitempty"`

	// The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'.
	FullyQualifiedResourceType *string `json:"fullyQualifiedResourceType,omitempty"`

	// The function name as it will appear in the policy rule. eg - 'vault'.
	Name *string `json:"name,omitempty"`
}

DataManifestCustomResourceFunctionDefinition - The custom resource function definition.

func (DataManifestCustomResourceFunctionDefinition) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type DataManifestCustomResourceFunctionDefinition.

type DataManifestResourceFunctionsDefinition

type DataManifestResourceFunctionsDefinition struct {
	// An array of data manifest custom resource definition.
	Custom []*DataManifestCustomResourceFunctionDefinition `json:"custom,omitempty"`

	// The standard resource functions (subscription and/or resourceGroup).
	Standard []*string `json:"standard,omitempty"`
}

DataManifestResourceFunctionsDefinition - The resource functions supported by a manifest

func (DataManifestResourceFunctionsDefinition) MarshalJSON

func (d DataManifestResourceFunctionsDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataManifestResourceFunctionsDefinition.

type DataPolicyManifest

type DataPolicyManifest struct {
	// The data policy manifest properties.
	Properties *DataPolicyManifestProperties `json:"properties,omitempty"`

	// READ-ONLY; The ID of the data policy manifest.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the data policy manifest (it's the same as the Policy Mode).
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource (Microsoft.Authorization/dataPolicyManifests).
	Type *string `json:"type,omitempty" azure:"ro"`
}

DataPolicyManifest - The data policy manifest.

type DataPolicyManifestListResult

type DataPolicyManifestListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of data policy manifests.
	Value []*DataPolicyManifest `json:"value,omitempty"`
}

DataPolicyManifestListResult - List of data policy manifests.

func (DataPolicyManifestListResult) MarshalJSON

func (d DataPolicyManifestListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataPolicyManifestListResult.

type DataPolicyManifestProperties

type DataPolicyManifestProperties struct {
	// The effect definition.
	Effects []*DataEffect `json:"effects,omitempty"`

	// The non-alias field accessor values that can be used in the policy rule.
	FieldValues []*string `json:"fieldValues,omitempty"`

	// A value indicating whether policy mode is allowed only in built-in definitions.
	IsBuiltInOnly *bool `json:"isBuiltInOnly,omitempty"`

	// The list of namespaces for the data policy manifest.
	Namespaces []*string `json:"namespaces,omitempty"`

	// The policy mode of the data policy manifest.
	PolicyMode *string `json:"policyMode,omitempty"`

	// The resource functions definition specified in the data manifest.
	ResourceFunctions *DataManifestResourceFunctionsDefinition `json:"resourceFunctions,omitempty"`

	// An array of resource type aliases.
	ResourceTypeAliases []*ResourceTypeAliases `json:"resourceTypeAliases,omitempty"`
}

DataPolicyManifestProperties - The properties of the data policy manifest.

func (DataPolicyManifestProperties) MarshalJSON

func (d DataPolicyManifestProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataPolicyManifestProperties.

type DataPolicyManifestsClient

type DataPolicyManifestsClient struct {
	// contains filtered or unexported fields
}

DataPolicyManifestsClient contains the methods for the DataPolicyManifests group. Don't use this type directly, use NewDataPolicyManifestsClient() instead.

func NewDataPolicyManifestsClient

func NewDataPolicyManifestsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *DataPolicyManifestsClient

NewDataPolicyManifestsClient creates a new instance of DataPolicyManifestsClient with the specified values.

func (*DataPolicyManifestsClient) GetByPolicyMode

GetByPolicyMode - This operation retrieves the data policy manifest with the given policy mode. If the operation fails it returns the *CloudError error type.

func (*DataPolicyManifestsClient) List

List - This operation retrieves a list of all the data policy manifests that match the optional given $filter. Valid values for $filter are: "$filter=namespace eq '{0}'". If $filter is not provided, the unfiltered list includes all data policy manifests for data resource types. If $filter=namespace is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value. If the operation fails it returns the *CloudError error type.

type DataPolicyManifestsGetByPolicyModeOptions

type DataPolicyManifestsGetByPolicyModeOptions struct {
}

DataPolicyManifestsGetByPolicyModeOptions contains the optional parameters for the DataPolicyManifests.GetByPolicyMode method.

type DataPolicyManifestsGetByPolicyModeResponse

type DataPolicyManifestsGetByPolicyModeResponse struct {
	DataPolicyManifestsGetByPolicyModeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DataPolicyManifestsGetByPolicyModeResponse contains the response from method DataPolicyManifests.GetByPolicyMode.

type DataPolicyManifestsGetByPolicyModeResult

type DataPolicyManifestsGetByPolicyModeResult struct {
	DataPolicyManifest
}

DataPolicyManifestsGetByPolicyModeResult contains the result from method DataPolicyManifests.GetByPolicyMode.

type DataPolicyManifestsListOptions

type DataPolicyManifestsListOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: "namespace eq '{value}'". If $filter is not provided, no filtering is performed.
	// If $filter=namespace eq '{value}' is provided, the returned list only includes all data policy manifests that have a namespace matching the provided
	// value.
	Filter *string
}

DataPolicyManifestsListOptions contains the optional parameters for the DataPolicyManifests.List method.

type DataPolicyManifestsListPager

type DataPolicyManifestsListPager struct {
	// contains filtered or unexported fields
}

DataPolicyManifestsListPager provides operations for iterating over paged responses.

func (*DataPolicyManifestsListPager) Err

Err returns the last error encountered while paging.

func (*DataPolicyManifestsListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DataPolicyManifestsListPager) PageResponse

PageResponse returns the current DataPolicyManifestsListResponse page.

type DataPolicyManifestsListResponse

type DataPolicyManifestsListResponse struct {
	DataPolicyManifestsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DataPolicyManifestsListResponse contains the response from method DataPolicyManifests.List.

type DataPolicyManifestsListResult

type DataPolicyManifestsListResult struct {
	DataPolicyManifestListResult
}

DataPolicyManifestsListResult contains the result from method DataPolicyManifests.List.

type EnforcementMode

type EnforcementMode string

EnforcementMode - The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.

const (
	// EnforcementModeDefault - The policy effect is enforced during resource creation or update.
	EnforcementModeDefault EnforcementMode = "Default"
	// EnforcementModeDoNotEnforce - The policy effect is not enforced during resource creation or update.
	EnforcementModeDoNotEnforce EnforcementMode = "DoNotEnforce"
)

func PossibleEnforcementModeValues

func PossibleEnforcementModeValues() []EnforcementMode

PossibleEnforcementModeValues returns the possible values for the EnforcementMode const type.

func (EnforcementMode) ToPtr

func (c EnforcementMode) ToPtr() *EnforcementMode

ToPtr returns a *EnforcementMode pointing to the current value.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorResponse

type ErrorResponse struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorResponse `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

func (ErrorResponse) MarshalJSON

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

type ExemptionCategory

type ExemptionCategory string

ExemptionCategory - The policy exemption category. Possible values are Waiver and Mitigated.

const (
	// ExemptionCategoryMitigated - This category of exemptions usually means the mitigation actions have been applied to the scope.
	ExemptionCategoryMitigated ExemptionCategory = "Mitigated"
	// ExemptionCategoryWaiver - This category of exemptions usually means the scope is not applicable for the policy.
	ExemptionCategoryWaiver ExemptionCategory = "Waiver"
)

func PossibleExemptionCategoryValues

func PossibleExemptionCategoryValues() []ExemptionCategory

PossibleExemptionCategoryValues returns the possible values for the ExemptionCategory const type.

func (ExemptionCategory) ToPtr

ToPtr returns a *ExemptionCategory pointing to the current value.

type Identity

type Identity struct {
	// The identity type. This is the only required field when adding a system or user assigned identity to a resource.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// The user identity associated with the policy. The user identity dictionary key references will be ARM resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*UserAssignedIdentitiesValue `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal ID of the resource identity. This property will only be provided for a system assigned identity
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of the resource identity. This property will only be provided for a system assigned identity
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

Identity for the resource. Policy assignments support a maximum of one identity. That is either a system assigned identity or a single user assigned identity.

func (Identity) MarshalJSON

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Identity.

type NonComplianceMessage

type NonComplianceMessage struct {
	// REQUIRED; A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant
	// compliance results.
	Message *string `json:"message,omitempty"`

	// The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns
	// a policy set definition. If this is not provided
	// the message applies to all policies assigned by this policy assignment.
	PolicyDefinitionReferenceID *string `json:"policyDefinitionReferenceId,omitempty"`
}

NonComplianceMessage - A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results.

type ParameterDefinitionsValue

type ParameterDefinitionsValue struct {
	// The allowed values for the parameter.
	AllowedValues []map[string]interface{} `json:"allowedValues,omitempty"`

	// The default value for the parameter if no value is provided.
	DefaultValue map[string]interface{} `json:"defaultValue,omitempty"`

	// General metadata for the parameter.
	Metadata *ParameterDefinitionsValueMetadata `json:"metadata,omitempty"`

	// The data type of the parameter.
	Type *ParameterType `json:"type,omitempty"`
}

ParameterDefinitionsValue - The definition of a parameter that can be provided to the policy.

func (ParameterDefinitionsValue) MarshalJSON

func (p ParameterDefinitionsValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ParameterDefinitionsValue.

type ParameterDefinitionsValueMetadata

type ParameterDefinitionsValueMetadata struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]map[string]interface{}

	// Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This
	// property is useful in case you wish to assign
	// permissions outside the assignment scope.
	AssignPermissions *bool `json:"assignPermissions,omitempty"`

	// The description of the parameter.
	Description *string `json:"description,omitempty"`

	// The display name for the parameter.
	DisplayName *string `json:"displayName,omitempty"`

	// Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
	StrongType *string `json:"strongType,omitempty"`
}

ParameterDefinitionsValueMetadata - General metadata for the parameter.

func (ParameterDefinitionsValueMetadata) MarshalJSON

func (p ParameterDefinitionsValueMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ParameterDefinitionsValueMetadata.

func (*ParameterDefinitionsValueMetadata) UnmarshalJSON

func (p *ParameterDefinitionsValueMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ParameterDefinitionsValueMetadata.

type ParameterType

type ParameterType string

ParameterType - The data type of the parameter.

const (
	ParameterTypeArray    ParameterType = "Array"
	ParameterTypeBoolean  ParameterType = "Boolean"
	ParameterTypeDateTime ParameterType = "DateTime"
	ParameterTypeFloat    ParameterType = "Float"
	ParameterTypeInteger  ParameterType = "Integer"
	ParameterTypeObject   ParameterType = "Object"
	ParameterTypeString   ParameterType = "String"
)

func PossibleParameterTypeValues

func PossibleParameterTypeValues() []ParameterType

PossibleParameterTypeValues returns the possible values for the ParameterType const type.

func (ParameterType) ToPtr

func (c ParameterType) ToPtr() *ParameterType

ToPtr returns a *ParameterType pointing to the current value.

type ParameterValuesValue

type ParameterValuesValue struct {
	// The value of the parameter.
	Value map[string]interface{} `json:"value,omitempty"`
}

ParameterValuesValue - The value of a parameter.

type PolicyAssignment

type PolicyAssignment struct {
	// The managed identity associated with the policy assignment.
	Identity *Identity `json:"identity,omitempty"`

	// The location of the policy assignment. Only required when utilizing managed identity.
	Location *string `json:"location,omitempty"`

	// Properties for the policy assignment.
	Properties *PolicyAssignmentProperties `json:"properties,omitempty"`

	// READ-ONLY; The ID of the policy assignment.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the policy assignment.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the policy assignment.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PolicyAssignment - The policy assignment.

type PolicyAssignmentListResult

type PolicyAssignmentListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of policy assignments.
	Value []*PolicyAssignment `json:"value,omitempty"`
}

PolicyAssignmentListResult - List of policy assignments.

func (PolicyAssignmentListResult) MarshalJSON

func (p PolicyAssignmentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyAssignmentListResult.

type PolicyAssignmentProperties

type PolicyAssignmentProperties struct {
	// This message will be part of response in case of policy violation.
	Description *string `json:"description,omitempty"`

	// The display name of the policy assignment.
	DisplayName *string `json:"displayName,omitempty"`

	// The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.
	EnforcementMode *EnforcementMode `json:"enforcementMode,omitempty"`

	// The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// The messages that describe why a resource is non-compliant with the policy.
	NonComplianceMessages []*NonComplianceMessage `json:"nonComplianceMessages,omitempty"`

	// The policy's excluded scopes.
	NotScopes []*string `json:"notScopes,omitempty"`

	// The parameter values for the assigned policy rule. The keys are the parameter names.
	Parameters map[string]*ParameterValuesValue `json:"parameters,omitempty"`

	// The ID of the policy definition or policy set definition being assigned.
	PolicyDefinitionID *string `json:"policyDefinitionId,omitempty"`

	// READ-ONLY; The scope for the policy assignment.
	Scope *string `json:"scope,omitempty" azure:"ro"`
}

PolicyAssignmentProperties - The policy assignment properties.

func (PolicyAssignmentProperties) MarshalJSON

func (p PolicyAssignmentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyAssignmentProperties.

type PolicyAssignmentUpdate

type PolicyAssignmentUpdate struct {
	// The managed identity associated with the policy assignment.
	Identity *Identity `json:"identity,omitempty"`

	// The location of the policy assignment. Only required when utilizing managed identity.
	Location *string `json:"location,omitempty"`
}

func (PolicyAssignmentUpdate) MarshalJSON

func (p PolicyAssignmentUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyAssignmentUpdate.

type PolicyAssignmentsClient

type PolicyAssignmentsClient struct {
	// contains filtered or unexported fields
}

PolicyAssignmentsClient contains the methods for the PolicyAssignments group. Don't use this type directly, use NewPolicyAssignmentsClient() instead.

func NewPolicyAssignmentsClient

func NewPolicyAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PolicyAssignmentsClient

NewPolicyAssignmentsClient creates a new instance of PolicyAssignmentsClient with the specified values.

func (*PolicyAssignmentsClient) Create

func (client *PolicyAssignmentsClient) Create(ctx context.Context, scope string, policyAssignmentName string, parameters PolicyAssignment, options *PolicyAssignmentsCreateOptions) (PolicyAssignmentsCreateResponse, error)

Create - This operation creates or updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) CreateByID

CreateByID - This operation creates or updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) Delete

func (client *PolicyAssignmentsClient) Delete(ctx context.Context, scope string, policyAssignmentName string, options *PolicyAssignmentsDeleteOptions) (PolicyAssignmentsDeleteResponse, error)

Delete - This operation deletes a policy assignment, given its name and the scope it was created in. The scope of a policy assignment is the part of its ID preceding '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) DeleteByID

DeleteByID - This operation deletes the policy with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid formats for {scope} are: '/providers/Microsoft.Management/managementGroups/{managementGroup}' (management group), '/subscriptions/{subscriptionId}' (subscription), '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' (resource group), or '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' (resource). If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) Get

func (client *PolicyAssignmentsClient) Get(ctx context.Context, scope string, policyAssignmentName string, options *PolicyAssignmentsGetOptions) (PolicyAssignmentsGetResponse, error)

Get - This operation retrieves a single policy assignment, given its name and the scope it was created at. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) GetByID

GetByID - The operation retrieves the policy assignment with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) List

List - This operation retrieves the list of all policy assignments associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter is not provided, the unfiltered list includes all policy assignments associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the subscription, which is everything in the unfiltered list except those applied to objects contained within the subscription. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the subscription. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) ListForManagementGroup

ListForManagementGroup - This operation retrieves the list of all policy assignments applicable to the management group that match the given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter=atScope() is provided, the returned list includes all policy assignments that are assigned to the management group or the management group's ancestors. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the management group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the management group. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) ListForResource

func (client *PolicyAssignmentsClient) ListForResource(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, options *PolicyAssignmentsListForResourceOptions) *PolicyAssignmentsListForResourcePager

ListForResource - This operation retrieves the list of all policy assignments associated with the specified resource in the given resource group and subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource, which is everything in the unfiltered list except those applied to resources contained within the resource. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource level. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the resource. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ”). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == ”, {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == ”, {parentResourcePath} == ”, {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp'). If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) ListForResourceGroup

ListForResourceGroup - This operation retrieves the list of all policy assignments associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource group, which is everything in the unfiltered list except those applied to resources contained within the resource group. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the resource group. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) Update

Update - This operation updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group. If the operation fails it returns the *CloudError error type.

func (*PolicyAssignmentsClient) UpdateByID

UpdateByID - This operation updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'. If the operation fails it returns the *CloudError error type.

type PolicyAssignmentsCreateByIDOptions

type PolicyAssignmentsCreateByIDOptions struct {
}

PolicyAssignmentsCreateByIDOptions contains the optional parameters for the PolicyAssignments.CreateByID method.

type PolicyAssignmentsCreateByIDResponse

type PolicyAssignmentsCreateByIDResponse struct {
	PolicyAssignmentsCreateByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsCreateByIDResponse contains the response from method PolicyAssignments.CreateByID.

type PolicyAssignmentsCreateByIDResult

type PolicyAssignmentsCreateByIDResult struct {
	PolicyAssignment
}

PolicyAssignmentsCreateByIDResult contains the result from method PolicyAssignments.CreateByID.

type PolicyAssignmentsCreateOptions

type PolicyAssignmentsCreateOptions struct {
}

PolicyAssignmentsCreateOptions contains the optional parameters for the PolicyAssignments.Create method.

type PolicyAssignmentsCreateResponse

type PolicyAssignmentsCreateResponse struct {
	PolicyAssignmentsCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsCreateResponse contains the response from method PolicyAssignments.Create.

type PolicyAssignmentsCreateResult

type PolicyAssignmentsCreateResult struct {
	PolicyAssignment
}

PolicyAssignmentsCreateResult contains the result from method PolicyAssignments.Create.

type PolicyAssignmentsDeleteByIDOptions

type PolicyAssignmentsDeleteByIDOptions struct {
}

PolicyAssignmentsDeleteByIDOptions contains the optional parameters for the PolicyAssignments.DeleteByID method.

type PolicyAssignmentsDeleteByIDResponse

type PolicyAssignmentsDeleteByIDResponse struct {
	PolicyAssignmentsDeleteByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsDeleteByIDResponse contains the response from method PolicyAssignments.DeleteByID.

type PolicyAssignmentsDeleteByIDResult

type PolicyAssignmentsDeleteByIDResult struct {
	PolicyAssignment
}

PolicyAssignmentsDeleteByIDResult contains the result from method PolicyAssignments.DeleteByID.

type PolicyAssignmentsDeleteOptions

type PolicyAssignmentsDeleteOptions struct {
}

PolicyAssignmentsDeleteOptions contains the optional parameters for the PolicyAssignments.Delete method.

type PolicyAssignmentsDeleteResponse

type PolicyAssignmentsDeleteResponse struct {
	PolicyAssignmentsDeleteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsDeleteResponse contains the response from method PolicyAssignments.Delete.

type PolicyAssignmentsDeleteResult

type PolicyAssignmentsDeleteResult struct {
	PolicyAssignment
}

PolicyAssignmentsDeleteResult contains the result from method PolicyAssignments.Delete.

type PolicyAssignmentsGetByIDOptions

type PolicyAssignmentsGetByIDOptions struct {
}

PolicyAssignmentsGetByIDOptions contains the optional parameters for the PolicyAssignments.GetByID method.

type PolicyAssignmentsGetByIDResponse

type PolicyAssignmentsGetByIDResponse struct {
	PolicyAssignmentsGetByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsGetByIDResponse contains the response from method PolicyAssignments.GetByID.

type PolicyAssignmentsGetByIDResult

type PolicyAssignmentsGetByIDResult struct {
	PolicyAssignment
}

PolicyAssignmentsGetByIDResult contains the result from method PolicyAssignments.GetByID.

type PolicyAssignmentsGetOptions

type PolicyAssignmentsGetOptions struct {
}

PolicyAssignmentsGetOptions contains the optional parameters for the PolicyAssignments.Get method.

type PolicyAssignmentsGetResponse

type PolicyAssignmentsGetResponse struct {
	PolicyAssignmentsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsGetResponse contains the response from method PolicyAssignments.Get.

type PolicyAssignmentsGetResult

type PolicyAssignmentsGetResult struct {
	PolicyAssignment
}

PolicyAssignmentsGetResult contains the result from method PolicyAssignments.Get.

type PolicyAssignmentsListForManagementGroupOptions

type PolicyAssignmentsListForManagementGroupOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter is
	// not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope,
	// which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided,
	// the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned
	// list includes all policy assignments of the policy definition whose id is {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicyAssignmentsListForManagementGroupOptions contains the optional parameters for the PolicyAssignments.ListForManagementGroup method.

type PolicyAssignmentsListForManagementGroupPager

type PolicyAssignmentsListForManagementGroupPager struct {
	// contains filtered or unexported fields
}

PolicyAssignmentsListForManagementGroupPager provides operations for iterating over paged responses.

func (*PolicyAssignmentsListForManagementGroupPager) Err

Err returns the last error encountered while paging.

func (*PolicyAssignmentsListForManagementGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyAssignmentsListForManagementGroupPager) PageResponse

PageResponse returns the current PolicyAssignmentsListForManagementGroupResponse page.

type PolicyAssignmentsListForManagementGroupResponse

type PolicyAssignmentsListForManagementGroupResponse struct {
	PolicyAssignmentsListForManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsListForManagementGroupResponse contains the response from method PolicyAssignments.ListForManagementGroup.

type PolicyAssignmentsListForManagementGroupResult

type PolicyAssignmentsListForManagementGroupResult struct {
	PolicyAssignmentListResult
}

PolicyAssignmentsListForManagementGroupResult contains the result from method PolicyAssignments.ListForManagementGroup.

type PolicyAssignmentsListForResourceGroupOptions

type PolicyAssignmentsListForResourceGroupOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter is
	// not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope,
	// which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided,
	// the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned
	// list includes all policy assignments of the policy definition whose id is {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicyAssignmentsListForResourceGroupOptions contains the optional parameters for the PolicyAssignments.ListForResourceGroup method.

type PolicyAssignmentsListForResourceGroupPager

type PolicyAssignmentsListForResourceGroupPager struct {
	// contains filtered or unexported fields
}

PolicyAssignmentsListForResourceGroupPager provides operations for iterating over paged responses.

func (*PolicyAssignmentsListForResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*PolicyAssignmentsListForResourceGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyAssignmentsListForResourceGroupPager) PageResponse

PageResponse returns the current PolicyAssignmentsListForResourceGroupResponse page.

type PolicyAssignmentsListForResourceGroupResponse

type PolicyAssignmentsListForResourceGroupResponse struct {
	PolicyAssignmentsListForResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsListForResourceGroupResponse contains the response from method PolicyAssignments.ListForResourceGroup.

type PolicyAssignmentsListForResourceGroupResult

type PolicyAssignmentsListForResourceGroupResult struct {
	PolicyAssignmentListResult
}

PolicyAssignmentsListForResourceGroupResult contains the result from method PolicyAssignments.ListForResourceGroup.

type PolicyAssignmentsListForResourceOptions

type PolicyAssignmentsListForResourceOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter is
	// not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope,
	// which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided,
	// the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned
	// list includes all policy assignments of the policy definition whose id is {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicyAssignmentsListForResourceOptions contains the optional parameters for the PolicyAssignments.ListForResource method.

type PolicyAssignmentsListForResourcePager

type PolicyAssignmentsListForResourcePager struct {
	// contains filtered or unexported fields
}

PolicyAssignmentsListForResourcePager provides operations for iterating over paged responses.

func (*PolicyAssignmentsListForResourcePager) Err

Err returns the last error encountered while paging.

func (*PolicyAssignmentsListForResourcePager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyAssignmentsListForResourcePager) PageResponse

PageResponse returns the current PolicyAssignmentsListForResourceResponse page.

type PolicyAssignmentsListForResourceResponse

type PolicyAssignmentsListForResourceResponse struct {
	PolicyAssignmentsListForResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsListForResourceResponse contains the response from method PolicyAssignments.ListForResource.

type PolicyAssignmentsListForResourceResult

type PolicyAssignmentsListForResourceResult struct {
	PolicyAssignmentListResult
}

PolicyAssignmentsListForResourceResult contains the result from method PolicyAssignments.ListForResource.

type PolicyAssignmentsListOptions

type PolicyAssignmentsListOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}”. If $filter is
	// not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope,
	// which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided,
	// the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned
	// list includes all policy assignments of the policy definition whose id is {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicyAssignmentsListOptions contains the optional parameters for the PolicyAssignments.List method.

type PolicyAssignmentsListPager

type PolicyAssignmentsListPager struct {
	// contains filtered or unexported fields
}

PolicyAssignmentsListPager provides operations for iterating over paged responses.

func (*PolicyAssignmentsListPager) Err

Err returns the last error encountered while paging.

func (*PolicyAssignmentsListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyAssignmentsListPager) PageResponse

PageResponse returns the current PolicyAssignmentsListResponse page.

type PolicyAssignmentsListResponse

type PolicyAssignmentsListResponse struct {
	PolicyAssignmentsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsListResponse contains the response from method PolicyAssignments.List.

type PolicyAssignmentsListResult

type PolicyAssignmentsListResult struct {
	PolicyAssignmentListResult
}

PolicyAssignmentsListResult contains the result from method PolicyAssignments.List.

type PolicyAssignmentsUpdateByIDOptions

type PolicyAssignmentsUpdateByIDOptions struct {
}

PolicyAssignmentsUpdateByIDOptions contains the optional parameters for the PolicyAssignments.UpdateByID method.

type PolicyAssignmentsUpdateByIDResponse

type PolicyAssignmentsUpdateByIDResponse struct {
	PolicyAssignmentsUpdateByIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsUpdateByIDResponse contains the response from method PolicyAssignments.UpdateByID.

type PolicyAssignmentsUpdateByIDResult

type PolicyAssignmentsUpdateByIDResult struct {
	PolicyAssignment
}

PolicyAssignmentsUpdateByIDResult contains the result from method PolicyAssignments.UpdateByID.

type PolicyAssignmentsUpdateOptions

type PolicyAssignmentsUpdateOptions struct {
}

PolicyAssignmentsUpdateOptions contains the optional parameters for the PolicyAssignments.Update method.

type PolicyAssignmentsUpdateResponse

type PolicyAssignmentsUpdateResponse struct {
	PolicyAssignmentsUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyAssignmentsUpdateResponse contains the response from method PolicyAssignments.Update.

type PolicyAssignmentsUpdateResult

type PolicyAssignmentsUpdateResult struct {
	PolicyAssignment
}

PolicyAssignmentsUpdateResult contains the result from method PolicyAssignments.Update.

type PolicyDefinition

type PolicyDefinition struct {
	// The policy definition properties.
	Properties *PolicyDefinitionProperties `json:"properties,omitempty"`

	// READ-ONLY; The ID of the policy definition.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the policy definition.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource (Microsoft.Authorization/policyDefinitions).
	Type *string `json:"type,omitempty" azure:"ro"`
}

PolicyDefinition - The policy definition.

type PolicyDefinitionGroup

type PolicyDefinitionGroup struct {
	// REQUIRED; The name of the group.
	Name *string `json:"name,omitempty"`

	// A resource ID of a resource that contains additional metadata about the group.
	AdditionalMetadataID *string `json:"additionalMetadataId,omitempty"`

	// The group's category.
	Category *string `json:"category,omitempty"`

	// The group's description.
	Description *string `json:"description,omitempty"`

	// The group's display name.
	DisplayName *string `json:"displayName,omitempty"`
}

PolicyDefinitionGroup - The policy definition group.

type PolicyDefinitionListResult

type PolicyDefinitionListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of policy definitions.
	Value []*PolicyDefinition `json:"value,omitempty"`
}

PolicyDefinitionListResult - List of policy definitions.

func (PolicyDefinitionListResult) MarshalJSON

func (p PolicyDefinitionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyDefinitionListResult.

type PolicyDefinitionProperties

type PolicyDefinitionProperties struct {
	// The policy definition description.
	Description *string `json:"description,omitempty"`

	// The display name of the policy definition.
	DisplayName *string `json:"displayName,omitempty"`

	// The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
	Mode *string `json:"mode,omitempty"`

	// The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
	Parameters map[string]*ParameterDefinitionsValue `json:"parameters,omitempty"`

	// The policy rule.
	PolicyRule map[string]interface{} `json:"policyRule,omitempty"`

	// The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
	PolicyType *PolicyType `json:"policyType,omitempty"`
}

PolicyDefinitionProperties - The policy definition properties.

func (PolicyDefinitionProperties) MarshalJSON

func (p PolicyDefinitionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyDefinitionProperties.

type PolicyDefinitionReference

type PolicyDefinitionReference struct {
	// REQUIRED; The ID of the policy definition or policy set definition.
	PolicyDefinitionID *string `json:"policyDefinitionId,omitempty"`

	// The name of the groups that this policy definition reference belongs to.
	GroupNames []*string `json:"groupNames,omitempty"`

	// The parameter values for the referenced policy rule. The keys are the parameter names.
	Parameters map[string]*ParameterValuesValue `json:"parameters,omitempty"`

	// A unique id (within the policy set definition) for this policy definition reference.
	PolicyDefinitionReferenceID *string `json:"policyDefinitionReferenceId,omitempty"`
}

PolicyDefinitionReference - The policy definition reference.

func (PolicyDefinitionReference) MarshalJSON

func (p PolicyDefinitionReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyDefinitionReference.

type PolicyDefinitionsClient

type PolicyDefinitionsClient struct {
	// contains filtered or unexported fields
}

PolicyDefinitionsClient contains the methods for the PolicyDefinitions group. Don't use this type directly, use NewPolicyDefinitionsClient() instead.

func NewPolicyDefinitionsClient

func NewPolicyDefinitionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PolicyDefinitionsClient

NewPolicyDefinitionsClient creates a new instance of PolicyDefinitionsClient with the specified values.

func (*PolicyDefinitionsClient) CreateOrUpdate

CreateOrUpdate - This operation creates or updates a policy definition in the given subscription with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) CreateOrUpdateAtManagementGroup

func (client *PolicyDefinitionsClient) CreateOrUpdateAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, parameters PolicyDefinition, options *PolicyDefinitionsCreateOrUpdateAtManagementGroupOptions) (PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse, error)

CreateOrUpdateAtManagementGroup - This operation creates or updates a policy definition in the given management group with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) Delete

Delete - This operation deletes the policy definition in the given subscription with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) DeleteAtManagementGroup

func (client *PolicyDefinitionsClient) DeleteAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, options *PolicyDefinitionsDeleteAtManagementGroupOptions) (PolicyDefinitionsDeleteAtManagementGroupResponse, error)

DeleteAtManagementGroup - This operation deletes the policy definition in the given management group with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) Get

Get - This operation retrieves the policy definition in the given subscription with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) GetAtManagementGroup

func (client *PolicyDefinitionsClient) GetAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, options *PolicyDefinitionsGetAtManagementGroupOptions) (PolicyDefinitionsGetAtManagementGroupResponse, error)

GetAtManagementGroup - This operation retrieves the policy definition in the given management group with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) GetBuiltIn

GetBuiltIn - This operation retrieves the built-in policy definition with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) List

List - This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) ListBuiltIn

ListBuiltIn - This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}. If the operation fails it returns the *CloudError error type.

func (*PolicyDefinitionsClient) ListByManagementGroup

ListByManagementGroup - This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. If the operation fails it returns the *CloudError error type.

type PolicyDefinitionsCreateOrUpdateAtManagementGroupOptions

type PolicyDefinitionsCreateOrUpdateAtManagementGroupOptions struct {
}

PolicyDefinitionsCreateOrUpdateAtManagementGroupOptions contains the optional parameters for the PolicyDefinitions.CreateOrUpdateAtManagementGroup method.

type PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse

type PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse struct {
	PolicyDefinitionsCreateOrUpdateAtManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse contains the response from method PolicyDefinitions.CreateOrUpdateAtManagementGroup.

type PolicyDefinitionsCreateOrUpdateAtManagementGroupResult

type PolicyDefinitionsCreateOrUpdateAtManagementGroupResult struct {
	PolicyDefinition
}

PolicyDefinitionsCreateOrUpdateAtManagementGroupResult contains the result from method PolicyDefinitions.CreateOrUpdateAtManagementGroup.

type PolicyDefinitionsCreateOrUpdateOptions

type PolicyDefinitionsCreateOrUpdateOptions struct {
}

PolicyDefinitionsCreateOrUpdateOptions contains the optional parameters for the PolicyDefinitions.CreateOrUpdate method.

type PolicyDefinitionsCreateOrUpdateResponse

type PolicyDefinitionsCreateOrUpdateResponse struct {
	PolicyDefinitionsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsCreateOrUpdateResponse contains the response from method PolicyDefinitions.CreateOrUpdate.

type PolicyDefinitionsCreateOrUpdateResult

type PolicyDefinitionsCreateOrUpdateResult struct {
	PolicyDefinition
}

PolicyDefinitionsCreateOrUpdateResult contains the result from method PolicyDefinitions.CreateOrUpdate.

type PolicyDefinitionsDeleteAtManagementGroupOptions

type PolicyDefinitionsDeleteAtManagementGroupOptions struct {
}

PolicyDefinitionsDeleteAtManagementGroupOptions contains the optional parameters for the PolicyDefinitions.DeleteAtManagementGroup method.

type PolicyDefinitionsDeleteAtManagementGroupResponse

type PolicyDefinitionsDeleteAtManagementGroupResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsDeleteAtManagementGroupResponse contains the response from method PolicyDefinitions.DeleteAtManagementGroup.

type PolicyDefinitionsDeleteOptions

type PolicyDefinitionsDeleteOptions struct {
}

PolicyDefinitionsDeleteOptions contains the optional parameters for the PolicyDefinitions.Delete method.

type PolicyDefinitionsDeleteResponse

type PolicyDefinitionsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsDeleteResponse contains the response from method PolicyDefinitions.Delete.

type PolicyDefinitionsGetAtManagementGroupOptions

type PolicyDefinitionsGetAtManagementGroupOptions struct {
}

PolicyDefinitionsGetAtManagementGroupOptions contains the optional parameters for the PolicyDefinitions.GetAtManagementGroup method.

type PolicyDefinitionsGetAtManagementGroupResponse

type PolicyDefinitionsGetAtManagementGroupResponse struct {
	PolicyDefinitionsGetAtManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsGetAtManagementGroupResponse contains the response from method PolicyDefinitions.GetAtManagementGroup.

type PolicyDefinitionsGetAtManagementGroupResult

type PolicyDefinitionsGetAtManagementGroupResult struct {
	PolicyDefinition
}

PolicyDefinitionsGetAtManagementGroupResult contains the result from method PolicyDefinitions.GetAtManagementGroup.

type PolicyDefinitionsGetBuiltInOptions

type PolicyDefinitionsGetBuiltInOptions struct {
}

PolicyDefinitionsGetBuiltInOptions contains the optional parameters for the PolicyDefinitions.GetBuiltIn method.

type PolicyDefinitionsGetBuiltInResponse

type PolicyDefinitionsGetBuiltInResponse struct {
	PolicyDefinitionsGetBuiltInResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsGetBuiltInResponse contains the response from method PolicyDefinitions.GetBuiltIn.

type PolicyDefinitionsGetBuiltInResult

type PolicyDefinitionsGetBuiltInResult struct {
	PolicyDefinition
}

PolicyDefinitionsGetBuiltInResult contains the result from method PolicyDefinitions.GetBuiltIn.

type PolicyDefinitionsGetOptions

type PolicyDefinitionsGetOptions struct {
}

PolicyDefinitionsGetOptions contains the optional parameters for the PolicyDefinitions.Get method.

type PolicyDefinitionsGetResponse

type PolicyDefinitionsGetResponse struct {
	PolicyDefinitionsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsGetResponse contains the response from method PolicyDefinitions.Get.

type PolicyDefinitionsGetResult

type PolicyDefinitionsGetResult struct {
	PolicyDefinition
}

PolicyDefinitionsGetResult contains the result from method PolicyDefinitions.Get.

type PolicyDefinitionsListBuiltInOptions

type PolicyDefinitionsListBuiltInOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter
	// is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the
	// given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible
	// policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy
	// definitions whose category match the {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicyDefinitionsListBuiltInOptions contains the optional parameters for the PolicyDefinitions.ListBuiltIn method.

type PolicyDefinitionsListBuiltInPager

type PolicyDefinitionsListBuiltInPager struct {
	// contains filtered or unexported fields
}

PolicyDefinitionsListBuiltInPager provides operations for iterating over paged responses.

func (*PolicyDefinitionsListBuiltInPager) Err

Err returns the last error encountered while paging.

func (*PolicyDefinitionsListBuiltInPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyDefinitionsListBuiltInPager) PageResponse

PageResponse returns the current PolicyDefinitionsListBuiltInResponse page.

type PolicyDefinitionsListBuiltInResponse

type PolicyDefinitionsListBuiltInResponse struct {
	PolicyDefinitionsListBuiltInResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsListBuiltInResponse contains the response from method PolicyDefinitions.ListBuiltIn.

type PolicyDefinitionsListBuiltInResult

type PolicyDefinitionsListBuiltInResult struct {
	PolicyDefinitionListResult
}

PolicyDefinitionsListBuiltInResult contains the result from method PolicyDefinitions.ListBuiltIn.

type PolicyDefinitionsListByManagementGroupOptions

type PolicyDefinitionsListByManagementGroupOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter
	// is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the
	// given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible
	// policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy
	// definitions whose category match the {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicyDefinitionsListByManagementGroupOptions contains the optional parameters for the PolicyDefinitions.ListByManagementGroup method.

type PolicyDefinitionsListByManagementGroupPager

type PolicyDefinitionsListByManagementGroupPager struct {
	// contains filtered or unexported fields
}

PolicyDefinitionsListByManagementGroupPager provides operations for iterating over paged responses.

func (*PolicyDefinitionsListByManagementGroupPager) Err

Err returns the last error encountered while paging.

func (*PolicyDefinitionsListByManagementGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyDefinitionsListByManagementGroupPager) PageResponse

PageResponse returns the current PolicyDefinitionsListByManagementGroupResponse page.

type PolicyDefinitionsListByManagementGroupResponse

type PolicyDefinitionsListByManagementGroupResponse struct {
	PolicyDefinitionsListByManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsListByManagementGroupResponse contains the response from method PolicyDefinitions.ListByManagementGroup.

type PolicyDefinitionsListByManagementGroupResult

type PolicyDefinitionsListByManagementGroupResult struct {
	PolicyDefinitionListResult
}

PolicyDefinitionsListByManagementGroupResult contains the result from method PolicyDefinitions.ListByManagementGroup.

type PolicyDefinitionsListOptions

type PolicyDefinitionsListOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter
	// is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the
	// given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible
	// policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy
	// definitions whose category match the {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicyDefinitionsListOptions contains the optional parameters for the PolicyDefinitions.List method.

type PolicyDefinitionsListPager

type PolicyDefinitionsListPager struct {
	// contains filtered or unexported fields
}

PolicyDefinitionsListPager provides operations for iterating over paged responses.

func (*PolicyDefinitionsListPager) Err

Err returns the last error encountered while paging.

func (*PolicyDefinitionsListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyDefinitionsListPager) PageResponse

PageResponse returns the current PolicyDefinitionsListResponse page.

type PolicyDefinitionsListResponse

type PolicyDefinitionsListResponse struct {
	PolicyDefinitionsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDefinitionsListResponse contains the response from method PolicyDefinitions.List.

type PolicyDefinitionsListResult

type PolicyDefinitionsListResult struct {
	PolicyDefinitionListResult
}

PolicyDefinitionsListResult contains the result from method PolicyDefinitions.List.

type PolicyExemption

type PolicyExemption struct {
	// REQUIRED; Properties for the policy exemption.
	Properties *PolicyExemptionProperties `json:"properties,omitempty"`

	// READ-ONLY; The ID of the policy exemption.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the policy exemption.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource (Microsoft.Authorization/policyExemptions).
	Type *string `json:"type,omitempty" azure:"ro"`
}

PolicyExemption - The policy exemption.

type PolicyExemptionListResult

type PolicyExemptionListResult struct {
	// An array of policy exemptions.
	Value []*PolicyExemption `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PolicyExemptionListResult - List of policy exemptions.

func (PolicyExemptionListResult) MarshalJSON

func (p PolicyExemptionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyExemptionListResult.

type PolicyExemptionProperties

type PolicyExemptionProperties struct {
	// REQUIRED; The policy exemption category. Possible values are Waiver and Mitigated.
	ExemptionCategory *ExemptionCategory `json:"exemptionCategory,omitempty"`

	// REQUIRED; The ID of the policy assignment that is being exempted.
	PolicyAssignmentID *string `json:"policyAssignmentId,omitempty"`

	// The description of the policy exemption.
	Description *string `json:"description,omitempty"`

	// The display name of the policy exemption.
	DisplayName *string `json:"displayName,omitempty"`

	// The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
	ExpiresOn *time.Time `json:"expiresOn,omitempty"`

	// The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
	PolicyDefinitionReferenceIDs []*string `json:"policyDefinitionReferenceIds,omitempty"`
}

PolicyExemptionProperties - The policy exemption properties.

func (PolicyExemptionProperties) MarshalJSON

func (p PolicyExemptionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyExemptionProperties.

func (*PolicyExemptionProperties) UnmarshalJSON

func (p *PolicyExemptionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PolicyExemptionProperties.

type PolicyExemptionsClient

type PolicyExemptionsClient struct {
	// contains filtered or unexported fields
}

PolicyExemptionsClient contains the methods for the PolicyExemptions group. Don't use this type directly, use NewPolicyExemptionsClient() instead.

func NewPolicyExemptionsClient

func NewPolicyExemptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PolicyExemptionsClient

NewPolicyExemptionsClient creates a new instance of PolicyExemptionsClient with the specified values.

func (*PolicyExemptionsClient) CreateOrUpdate

func (client *PolicyExemptionsClient) CreateOrUpdate(ctx context.Context, scope string, policyExemptionName string, parameters PolicyExemption, options *PolicyExemptionsCreateOrUpdateOptions) (PolicyExemptionsCreateOrUpdateResponse, error)

CreateOrUpdate - This operation creates or updates a policy exemption with the given scope and name. Policy exemptions apply to all resources contained within their scope. For example, when you create a policy exemption at resource group scope for a policy assignment at the same or above level, the exemption exempts to all applicable resources in the resource group. If the operation fails it returns the *CloudError error type.

func (*PolicyExemptionsClient) Delete

func (client *PolicyExemptionsClient) Delete(ctx context.Context, scope string, policyExemptionName string, options *PolicyExemptionsDeleteOptions) (PolicyExemptionsDeleteResponse, error)

Delete - This operation deletes a policy exemption, given its name and the scope it was created in. The scope of a policy exemption is the part of its ID preceding '/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}'. If the operation fails it returns the *CloudError error type.

func (*PolicyExemptionsClient) Get

func (client *PolicyExemptionsClient) Get(ctx context.Context, scope string, policyExemptionName string, options *PolicyExemptionsGetOptions) (PolicyExemptionsGetResponse, error)

Get - This operation retrieves a single policy exemption, given its name and the scope it was created at. If the operation fails it returns the *CloudError error type.

func (*PolicyExemptionsClient) List

List - This operation retrieves the list of all policy exemptions associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription. If the operation fails it returns the *CloudError error type.

func (*PolicyExemptionsClient) ListForManagementGroup

ListForManagementGroup - This operation retrieves the list of all policy exemptions applicable to the management group that match the given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”. If $filter=atScope() is provided, the returned list includes all policy exemptions that are assigned to the management group or the management group's ancestors. If the operation fails it returns the *CloudError error type.

func (*PolicyExemptionsClient) ListForResource

func (client *PolicyExemptionsClient) ListForResource(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, options *PolicyExemptionsListForResourceOptions) *PolicyExemptionsListForResourcePager

ListForResource - This operation retrieves the list of all policy exemptions associated with the specified resource in the given resource group and subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the resource, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ”). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == ”, {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == ”, {parentResourcePath} == ”, {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp'). If the operation fails it returns the *CloudError error type.

func (*PolicyExemptionsClient) ListForResourceGroup

ListForResourceGroup - This operation retrieves the list of all policy exemptions associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group. If the operation fails it returns the *CloudError error type.

type PolicyExemptionsCreateOrUpdateOptions

type PolicyExemptionsCreateOrUpdateOptions struct {
}

PolicyExemptionsCreateOrUpdateOptions contains the optional parameters for the PolicyExemptions.CreateOrUpdate method.

type PolicyExemptionsCreateOrUpdateResponse

type PolicyExemptionsCreateOrUpdateResponse struct {
	PolicyExemptionsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyExemptionsCreateOrUpdateResponse contains the response from method PolicyExemptions.CreateOrUpdate.

type PolicyExemptionsCreateOrUpdateResult

type PolicyExemptionsCreateOrUpdateResult struct {
	PolicyExemption
}

PolicyExemptionsCreateOrUpdateResult contains the result from method PolicyExemptions.CreateOrUpdate.

type PolicyExemptionsDeleteOptions

type PolicyExemptionsDeleteOptions struct {
}

PolicyExemptionsDeleteOptions contains the optional parameters for the PolicyExemptions.Delete method.

type PolicyExemptionsDeleteResponse

type PolicyExemptionsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyExemptionsDeleteResponse contains the response from method PolicyExemptions.Delete.

type PolicyExemptionsGetOptions

type PolicyExemptionsGetOptions struct {
}

PolicyExemptionsGetOptions contains the optional parameters for the PolicyExemptions.Get method.

type PolicyExemptionsGetResponse

type PolicyExemptionsGetResponse struct {
	PolicyExemptionsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyExemptionsGetResponse contains the response from method PolicyExemptions.Get.

type PolicyExemptionsGetResult

type PolicyExemptionsGetResult struct {
	PolicyExemption
}

PolicyExemptionsGetResult contains the result from method PolicyExemptions.Get.

type PolicyExemptionsListForManagementGroupOptions

type PolicyExemptionsListForManagementGroupOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”.
	// If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with
	// the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all
	// policy exemptions that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope.
	// If $filter=atExactScope() is provided, the returned list only includes all policy exemptions that at the given scope. If $filter=excludeExpired() is
	// provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId
	// eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId.
	Filter *string
}

PolicyExemptionsListForManagementGroupOptions contains the optional parameters for the PolicyExemptions.ListForManagementGroup method.

type PolicyExemptionsListForManagementGroupPager

type PolicyExemptionsListForManagementGroupPager struct {
	// contains filtered or unexported fields
}

PolicyExemptionsListForManagementGroupPager provides operations for iterating over paged responses.

func (*PolicyExemptionsListForManagementGroupPager) Err

Err returns the last error encountered while paging.

func (*PolicyExemptionsListForManagementGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyExemptionsListForManagementGroupPager) PageResponse

PageResponse returns the current PolicyExemptionsListForManagementGroupResponse page.

type PolicyExemptionsListForManagementGroupResponse

type PolicyExemptionsListForManagementGroupResponse struct {
	PolicyExemptionsListForManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyExemptionsListForManagementGroupResponse contains the response from method PolicyExemptions.ListForManagementGroup.

type PolicyExemptionsListForManagementGroupResult

type PolicyExemptionsListForManagementGroupResult struct {
	PolicyExemptionListResult
}

PolicyExemptionsListForManagementGroupResult contains the result from method PolicyExemptions.ListForManagementGroup.

type PolicyExemptionsListForResourceGroupOptions

type PolicyExemptionsListForResourceGroupOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”.
	// If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with
	// the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all
	// policy exemptions that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope.
	// If $filter=atExactScope() is provided, the returned list only includes all policy exemptions that at the given scope. If $filter=excludeExpired() is
	// provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId
	// eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId.
	Filter *string
}

PolicyExemptionsListForResourceGroupOptions contains the optional parameters for the PolicyExemptions.ListForResourceGroup method.

type PolicyExemptionsListForResourceGroupPager

type PolicyExemptionsListForResourceGroupPager struct {
	// contains filtered or unexported fields
}

PolicyExemptionsListForResourceGroupPager provides operations for iterating over paged responses.

func (*PolicyExemptionsListForResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*PolicyExemptionsListForResourceGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyExemptionsListForResourceGroupPager) PageResponse

PageResponse returns the current PolicyExemptionsListForResourceGroupResponse page.

type PolicyExemptionsListForResourceGroupResponse

type PolicyExemptionsListForResourceGroupResponse struct {
	PolicyExemptionsListForResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyExemptionsListForResourceGroupResponse contains the response from method PolicyExemptions.ListForResourceGroup.

type PolicyExemptionsListForResourceGroupResult

type PolicyExemptionsListForResourceGroupResult struct {
	PolicyExemptionListResult
}

PolicyExemptionsListForResourceGroupResult contains the result from method PolicyExemptions.ListForResourceGroup.

type PolicyExemptionsListForResourceOptions

type PolicyExemptionsListForResourceOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”.
	// If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with
	// the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all
	// policy exemptions that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope.
	// If $filter=atExactScope() is provided, the returned list only includes all policy exemptions that at the given scope. If $filter=excludeExpired() is
	// provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId
	// eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId.
	Filter *string
}

PolicyExemptionsListForResourceOptions contains the optional parameters for the PolicyExemptions.ListForResource method.

type PolicyExemptionsListForResourcePager

type PolicyExemptionsListForResourcePager struct {
	// contains filtered or unexported fields
}

PolicyExemptionsListForResourcePager provides operations for iterating over paged responses.

func (*PolicyExemptionsListForResourcePager) Err

Err returns the last error encountered while paging.

func (*PolicyExemptionsListForResourcePager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyExemptionsListForResourcePager) PageResponse

PageResponse returns the current PolicyExemptionsListForResourceResponse page.

type PolicyExemptionsListForResourceResponse

type PolicyExemptionsListForResourceResponse struct {
	PolicyExemptionsListForResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyExemptionsListForResourceResponse contains the response from method PolicyExemptions.ListForResource.

type PolicyExemptionsListForResourceResult

type PolicyExemptionsListForResourceResult struct {
	PolicyExemptionListResult
}

PolicyExemptionsListForResourceResult contains the result from method PolicyExemptions.ListForResource.

type PolicyExemptionsListOptions

type PolicyExemptionsListOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}”.
	// If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with
	// the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all
	// policy exemptions that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope.
	// If $filter=atExactScope() is provided, the returned list only includes all policy exemptions that at the given scope. If $filter=excludeExpired() is
	// provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId
	// eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId.
	Filter *string
}

PolicyExemptionsListOptions contains the optional parameters for the PolicyExemptions.List method.

type PolicyExemptionsListPager

type PolicyExemptionsListPager struct {
	// contains filtered or unexported fields
}

PolicyExemptionsListPager provides operations for iterating over paged responses.

func (*PolicyExemptionsListPager) Err

Err returns the last error encountered while paging.

func (*PolicyExemptionsListPager) NextPage

func (p *PolicyExemptionsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicyExemptionsListPager) PageResponse

PageResponse returns the current PolicyExemptionsListResponse page.

type PolicyExemptionsListResponse

type PolicyExemptionsListResponse struct {
	PolicyExemptionsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyExemptionsListResponse contains the response from method PolicyExemptions.List.

type PolicyExemptionsListResult

type PolicyExemptionsListResult struct {
	PolicyExemptionListResult
}

PolicyExemptionsListResult contains the result from method PolicyExemptions.List.

type PolicySetDefinition

type PolicySetDefinition struct {
	// The policy definition properties.
	Properties *PolicySetDefinitionProperties `json:"properties,omitempty"`

	// READ-ONLY; The ID of the policy set definition.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the policy set definition.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource (Microsoft.Authorization/policySetDefinitions).
	Type *string `json:"type,omitempty" azure:"ro"`
}

PolicySetDefinition - The policy set definition.

type PolicySetDefinitionListResult

type PolicySetDefinitionListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of policy set definitions.
	Value []*PolicySetDefinition `json:"value,omitempty"`
}

PolicySetDefinitionListResult - List of policy set definitions.

func (PolicySetDefinitionListResult) MarshalJSON

func (p PolicySetDefinitionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicySetDefinitionListResult.

type PolicySetDefinitionProperties

type PolicySetDefinitionProperties struct {
	// REQUIRED; An array of policy definition references.
	PolicyDefinitions []*PolicyDefinitionReference `json:"policyDefinitions,omitempty"`

	// The policy set definition description.
	Description *string `json:"description,omitempty"`

	// The display name of the policy set definition.
	DisplayName *string `json:"displayName,omitempty"`

	// The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// The policy set definition parameters that can be used in policy definition references.
	Parameters map[string]*ParameterDefinitionsValue `json:"parameters,omitempty"`

	// The metadata describing groups of policy definition references within the policy set definition.
	PolicyDefinitionGroups []*PolicyDefinitionGroup `json:"policyDefinitionGroups,omitempty"`

	// The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
	PolicyType *PolicyType `json:"policyType,omitempty"`
}

PolicySetDefinitionProperties - The policy set definition properties.

func (PolicySetDefinitionProperties) MarshalJSON

func (p PolicySetDefinitionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicySetDefinitionProperties.

type PolicySetDefinitionsClient

type PolicySetDefinitionsClient struct {
	// contains filtered or unexported fields
}

PolicySetDefinitionsClient contains the methods for the PolicySetDefinitions group. Don't use this type directly, use NewPolicySetDefinitionsClient() instead.

func NewPolicySetDefinitionsClient

func NewPolicySetDefinitionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PolicySetDefinitionsClient

NewPolicySetDefinitionsClient creates a new instance of PolicySetDefinitionsClient with the specified values.

func (*PolicySetDefinitionsClient) CreateOrUpdate

CreateOrUpdate - This operation creates or updates a policy set definition in the given subscription with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) CreateOrUpdateAtManagementGroup

func (client *PolicySetDefinitionsClient) CreateOrUpdateAtManagementGroup(ctx context.Context, policySetDefinitionName string, managementGroupID string, parameters PolicySetDefinition, options *PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptions) (PolicySetDefinitionsCreateOrUpdateAtManagementGroupResponse, error)

CreateOrUpdateAtManagementGroup - This operation creates or updates a policy set definition in the given management group with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) Delete

Delete - This operation deletes the policy set definition in the given subscription with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) DeleteAtManagementGroup

func (client *PolicySetDefinitionsClient) DeleteAtManagementGroup(ctx context.Context, policySetDefinitionName string, managementGroupID string, options *PolicySetDefinitionsDeleteAtManagementGroupOptions) (PolicySetDefinitionsDeleteAtManagementGroupResponse, error)

DeleteAtManagementGroup - This operation deletes the policy set definition in the given management group with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) Get

Get - This operation retrieves the policy set definition in the given subscription with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) GetAtManagementGroup

func (client *PolicySetDefinitionsClient) GetAtManagementGroup(ctx context.Context, policySetDefinitionName string, managementGroupID string, options *PolicySetDefinitionsGetAtManagementGroupOptions) (PolicySetDefinitionsGetAtManagementGroupResponse, error)

GetAtManagementGroup - This operation retrieves the policy set definition in the given management group with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) GetBuiltIn

GetBuiltIn - This operation retrieves the built-in policy set definition with the given name. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) List

List - This operation retrieves a list of all the policy set definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) ListBuiltIn

ListBuiltIn - This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}. If the operation fails it returns the *CloudError error type.

func (*PolicySetDefinitionsClient) ListByManagementGroup

ListByManagementGroup - This operation retrieves a list of all the policy set definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. If the operation fails it returns the *CloudError error type.

type PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptions

type PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptions struct {
}

PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptions contains the optional parameters for the PolicySetDefinitions.CreateOrUpdateAtManagementGroup method.

type PolicySetDefinitionsCreateOrUpdateAtManagementGroupResponse

type PolicySetDefinitionsCreateOrUpdateAtManagementGroupResponse struct {
	PolicySetDefinitionsCreateOrUpdateAtManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsCreateOrUpdateAtManagementGroupResponse contains the response from method PolicySetDefinitions.CreateOrUpdateAtManagementGroup.

type PolicySetDefinitionsCreateOrUpdateAtManagementGroupResult

type PolicySetDefinitionsCreateOrUpdateAtManagementGroupResult struct {
	PolicySetDefinition
}

PolicySetDefinitionsCreateOrUpdateAtManagementGroupResult contains the result from method PolicySetDefinitions.CreateOrUpdateAtManagementGroup.

type PolicySetDefinitionsCreateOrUpdateOptions

type PolicySetDefinitionsCreateOrUpdateOptions struct {
}

PolicySetDefinitionsCreateOrUpdateOptions contains the optional parameters for the PolicySetDefinitions.CreateOrUpdate method.

type PolicySetDefinitionsCreateOrUpdateResponse

type PolicySetDefinitionsCreateOrUpdateResponse struct {
	PolicySetDefinitionsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsCreateOrUpdateResponse contains the response from method PolicySetDefinitions.CreateOrUpdate.

type PolicySetDefinitionsCreateOrUpdateResult

type PolicySetDefinitionsCreateOrUpdateResult struct {
	PolicySetDefinition
}

PolicySetDefinitionsCreateOrUpdateResult contains the result from method PolicySetDefinitions.CreateOrUpdate.

type PolicySetDefinitionsDeleteAtManagementGroupOptions

type PolicySetDefinitionsDeleteAtManagementGroupOptions struct {
}

PolicySetDefinitionsDeleteAtManagementGroupOptions contains the optional parameters for the PolicySetDefinitions.DeleteAtManagementGroup method.

type PolicySetDefinitionsDeleteAtManagementGroupResponse

type PolicySetDefinitionsDeleteAtManagementGroupResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsDeleteAtManagementGroupResponse contains the response from method PolicySetDefinitions.DeleteAtManagementGroup.

type PolicySetDefinitionsDeleteOptions

type PolicySetDefinitionsDeleteOptions struct {
}

PolicySetDefinitionsDeleteOptions contains the optional parameters for the PolicySetDefinitions.Delete method.

type PolicySetDefinitionsDeleteResponse

type PolicySetDefinitionsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsDeleteResponse contains the response from method PolicySetDefinitions.Delete.

type PolicySetDefinitionsGetAtManagementGroupOptions

type PolicySetDefinitionsGetAtManagementGroupOptions struct {
}

PolicySetDefinitionsGetAtManagementGroupOptions contains the optional parameters for the PolicySetDefinitions.GetAtManagementGroup method.

type PolicySetDefinitionsGetAtManagementGroupResponse

type PolicySetDefinitionsGetAtManagementGroupResponse struct {
	PolicySetDefinitionsGetAtManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsGetAtManagementGroupResponse contains the response from method PolicySetDefinitions.GetAtManagementGroup.

type PolicySetDefinitionsGetAtManagementGroupResult

type PolicySetDefinitionsGetAtManagementGroupResult struct {
	PolicySetDefinition
}

PolicySetDefinitionsGetAtManagementGroupResult contains the result from method PolicySetDefinitions.GetAtManagementGroup.

type PolicySetDefinitionsGetBuiltInOptions

type PolicySetDefinitionsGetBuiltInOptions struct {
}

PolicySetDefinitionsGetBuiltInOptions contains the optional parameters for the PolicySetDefinitions.GetBuiltIn method.

type PolicySetDefinitionsGetBuiltInResponse

type PolicySetDefinitionsGetBuiltInResponse struct {
	PolicySetDefinitionsGetBuiltInResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsGetBuiltInResponse contains the response from method PolicySetDefinitions.GetBuiltIn.

type PolicySetDefinitionsGetBuiltInResult

type PolicySetDefinitionsGetBuiltInResult struct {
	PolicySetDefinition
}

PolicySetDefinitionsGetBuiltInResult contains the result from method PolicySetDefinitions.GetBuiltIn.

type PolicySetDefinitionsGetOptions

type PolicySetDefinitionsGetOptions struct {
}

PolicySetDefinitionsGetOptions contains the optional parameters for the PolicySetDefinitions.Get method.

type PolicySetDefinitionsGetResponse

type PolicySetDefinitionsGetResponse struct {
	PolicySetDefinitionsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsGetResponse contains the response from method PolicySetDefinitions.Get.

type PolicySetDefinitionsGetResult

type PolicySetDefinitionsGetResult struct {
	PolicySetDefinition
}

PolicySetDefinitionsGetResult contains the result from method PolicySetDefinitions.Get.

type PolicySetDefinitionsListBuiltInOptions

type PolicySetDefinitionsListBuiltInOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter
	// is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at
	// the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}.
	// Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes
	// all policy set definitions whose category match the {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicySetDefinitionsListBuiltInOptions contains the optional parameters for the PolicySetDefinitions.ListBuiltIn method.

type PolicySetDefinitionsListBuiltInPager

type PolicySetDefinitionsListBuiltInPager struct {
	// contains filtered or unexported fields
}

PolicySetDefinitionsListBuiltInPager provides operations for iterating over paged responses.

func (*PolicySetDefinitionsListBuiltInPager) Err

Err returns the last error encountered while paging.

func (*PolicySetDefinitionsListBuiltInPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicySetDefinitionsListBuiltInPager) PageResponse

PageResponse returns the current PolicySetDefinitionsListBuiltInResponse page.

type PolicySetDefinitionsListBuiltInResponse

type PolicySetDefinitionsListBuiltInResponse struct {
	PolicySetDefinitionsListBuiltInResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsListBuiltInResponse contains the response from method PolicySetDefinitions.ListBuiltIn.

type PolicySetDefinitionsListBuiltInResult

type PolicySetDefinitionsListBuiltInResult struct {
	PolicySetDefinitionListResult
}

PolicySetDefinitionsListBuiltInResult contains the result from method PolicySetDefinitions.ListBuiltIn.

type PolicySetDefinitionsListByManagementGroupOptions

type PolicySetDefinitionsListByManagementGroupOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter
	// is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at
	// the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}.
	// Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes
	// all policy set definitions whose category match the {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicySetDefinitionsListByManagementGroupOptions contains the optional parameters for the PolicySetDefinitions.ListByManagementGroup method.

type PolicySetDefinitionsListByManagementGroupPager

type PolicySetDefinitionsListByManagementGroupPager struct {
	// contains filtered or unexported fields
}

PolicySetDefinitionsListByManagementGroupPager provides operations for iterating over paged responses.

func (*PolicySetDefinitionsListByManagementGroupPager) Err

Err returns the last error encountered while paging.

func (*PolicySetDefinitionsListByManagementGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicySetDefinitionsListByManagementGroupPager) PageResponse

PageResponse returns the current PolicySetDefinitionsListByManagementGroupResponse page.

type PolicySetDefinitionsListByManagementGroupResponse

type PolicySetDefinitionsListByManagementGroupResponse struct {
	PolicySetDefinitionsListByManagementGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsListByManagementGroupResponse contains the response from method PolicySetDefinitions.ListByManagementGroup.

type PolicySetDefinitionsListByManagementGroupResult

type PolicySetDefinitionsListByManagementGroupResult struct {
	PolicySetDefinitionListResult
}

PolicySetDefinitionsListByManagementGroupResult contains the result from method PolicySetDefinitions.ListByManagementGroup.

type PolicySetDefinitionsListOptions

type PolicySetDefinitionsListOptions struct {
	// The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}”. If $filter
	// is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at
	// the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}.
	// Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes
	// all policy set definitions whose category match the {value}.
	Filter *string
	// Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
	Top *int32
}

PolicySetDefinitionsListOptions contains the optional parameters for the PolicySetDefinitions.List method.

type PolicySetDefinitionsListPager

type PolicySetDefinitionsListPager struct {
	// contains filtered or unexported fields
}

PolicySetDefinitionsListPager provides operations for iterating over paged responses.

func (*PolicySetDefinitionsListPager) Err

Err returns the last error encountered while paging.

func (*PolicySetDefinitionsListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PolicySetDefinitionsListPager) PageResponse

PageResponse returns the current PolicySetDefinitionsListResponse page.

type PolicySetDefinitionsListResponse

type PolicySetDefinitionsListResponse struct {
	PolicySetDefinitionsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicySetDefinitionsListResponse contains the response from method PolicySetDefinitions.List.

type PolicySetDefinitionsListResult

type PolicySetDefinitionsListResult struct {
	PolicySetDefinitionListResult
}

PolicySetDefinitionsListResult contains the result from method PolicySetDefinitions.List.

type PolicyType

type PolicyType string

PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

const (
	PolicyTypeBuiltIn      PolicyType = "BuiltIn"
	PolicyTypeCustom       PolicyType = "Custom"
	PolicyTypeNotSpecified PolicyType = "NotSpecified"
	PolicyTypeStatic       PolicyType = "Static"
)

func PossiblePolicyTypeValues

func PossiblePolicyTypeValues() []PolicyType

PossiblePolicyTypeValues returns the possible values for the PolicyType const type.

func (PolicyType) ToPtr

func (c PolicyType) ToPtr() *PolicyType

ToPtr returns a *PolicyType pointing to the current value.

type ResourceIdentityType

type ResourceIdentityType string

ResourceIdentityType - The identity type. This is the only required field when adding a system or user assigned identity to a resource.

const (
	// ResourceIdentityTypeSystemAssigned - Indicates that a system assigned identity is associated with the resource.
	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
	// ResourceIdentityTypeUserAssigned - Indicates that a system assigned identity is associated with the resource.
	ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
	// ResourceIdentityTypeNone - Indicates that no identity is associated with the resource or that the existing identity should be removed.
	ResourceIdentityTypeNone ResourceIdentityType = "None"
)

func PossibleResourceIdentityTypeValues

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

func (ResourceIdentityType) ToPtr

ToPtr returns a *ResourceIdentityType pointing to the current value.

type ResourceTypeAliases

type ResourceTypeAliases struct {
	// The aliases for property names.
	Aliases []*Alias `json:"aliases,omitempty"`

	// The resource type name.
	ResourceType *string `json:"resourceType,omitempty"`
}

ResourceTypeAliases - The resource type aliases definition.

func (ResourceTypeAliases) MarshalJSON

func (r ResourceTypeAliases) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeAliases.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type UserAssignedIdentitiesValue

type UserAssignedIdentitiesValue struct {
	// READ-ONLY; The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL