const (
// DefaultBaseURI is the default URI used for the service Policy
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Alias the alias type.
type Alias struct {
// Name - The alias name.
Name *string `json:"name,omitempty"`
// Paths - The paths for an alias.
Paths *[]AliasPath `json:"paths,omitempty"`
// Type - The type of the alias. Possible values include: 'AliasTypeNotSpecified', 'AliasTypePlainText', 'AliasTypeMask'
Type AliasType `json:"type,omitempty"`
// DefaultPath - The default path for an alias.
DefaultPath *string `json:"defaultPath,omitempty"`
// DefaultPattern - The default pattern for an alias.
DefaultPattern *AliasPattern `json:"defaultPattern,omitempty"`
// DefaultMetadata - 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"`
}
func (a Alias) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Alias.
AliasPath the type of the paths for alias.
type AliasPath struct {
// Path - The path of an alias.
Path *string `json:"path,omitempty"`
// APIVersions - The API versions.
APIVersions *[]string `json:"apiVersions,omitempty"`
// Pattern - The pattern for an alias path.
Pattern *AliasPattern `json:"pattern,omitempty"`
// Metadata - READ-ONLY; The metadata of the alias path. If missing, fall back to the default metadata of the alias.
Metadata *AliasPathMetadata `json:"metadata,omitempty"`
}
func (ap AliasPath) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AliasPath.
AliasPathAttributes enumerates the values for alias path attributes.
type AliasPathAttributes string
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() []AliasPathAttributes
PossibleAliasPathAttributesValues returns an array of possible values for the AliasPathAttributes const type.
AliasPathMetadata ...
type AliasPathMetadata struct {
// Type - READ-ONLY; The type of the token that the alias path is referring to. Possible values include: 'AliasPathTokenTypeNotSpecified', 'AliasPathTokenTypeAny', 'AliasPathTokenTypeString', 'AliasPathTokenTypeObject', 'AliasPathTokenTypeArray', 'AliasPathTokenTypeInteger', 'AliasPathTokenTypeNumber', 'AliasPathTokenTypeBoolean'
Type AliasPathTokenType `json:"type,omitempty"`
// Attributes - READ-ONLY; The attributes of the token that the alias path is referring to. Possible values include: 'AliasPathAttributesNone', 'AliasPathAttributesModifiable'
Attributes AliasPathAttributes `json:"attributes,omitempty"`
}
func (apm AliasPathMetadata) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AliasPathMetadata.
AliasPathTokenType enumerates the values for alias path token type.
type AliasPathTokenType string
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() []AliasPathTokenType
PossibleAliasPathTokenTypeValues returns an array of possible values for the AliasPathTokenType const type.
AliasPattern the type of the pattern for an alias path.
type AliasPattern struct {
// Phrase - The alias pattern phrase.
Phrase *string `json:"phrase,omitempty"`
// Variable - The alias pattern variable.
Variable *string `json:"variable,omitempty"`
// Type - The type of alias pattern. Possible values include: 'AliasPatternTypeNotSpecified', 'AliasPatternTypeExtract'
Type AliasPatternType `json:"type,omitempty"`
}
AliasPatternType enumerates the values for alias pattern type.
type AliasPatternType string
const (
// AliasPatternTypeExtract Extract is the only allowed value.
AliasPatternTypeExtract AliasPatternType = "Extract"
// AliasPatternTypeNotSpecified NotSpecified is not allowed.
AliasPatternTypeNotSpecified AliasPatternType = "NotSpecified"
)
func PossibleAliasPatternTypeValues() []AliasPatternType
PossibleAliasPatternTypeValues returns an array of possible values for the AliasPatternType const type.
AliasType enumerates the values for alias type.
type AliasType string
const (
// AliasTypeMask Alias value is secret.
AliasTypeMask AliasType = "Mask"
// AliasTypeNotSpecified Alias type is unknown (same as not providing alias type).
AliasTypeNotSpecified AliasType = "NotSpecified"
// AliasTypePlainText Alias value is not secret.
AliasTypePlainText AliasType = "PlainText"
)
func PossibleAliasTypeValues() []AliasType
PossibleAliasTypeValues returns an array of possible values for the AliasType const type.
Assignment the policy assignment.
type Assignment struct {
autorest.Response `json:"-"`
// AssignmentProperties - Properties for the policy assignment.
*AssignmentProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the policy assignment.
ID *string `json:"id,omitempty"`
// Type - READ-ONLY; The type of the policy assignment.
Type *string `json:"type,omitempty"`
// Name - READ-ONLY; The name of the policy assignment.
Name *string `json:"name,omitempty"`
// Location - The location of the policy assignment. Only required when utilizing managed identity.
Location *string `json:"location,omitempty"`
// Identity - The managed identity associated with the policy assignment.
Identity *Identity `json:"identity,omitempty"`
}
func (a Assignment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Assignment.
func (a *Assignment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Assignment struct.
AssignmentListResult list of policy assignments.
type AssignmentListResult struct {
autorest.Response `json:"-"`
// Value - An array of policy assignments.
Value *[]Assignment `json:"value,omitempty"`
// NextLink - The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (alr AssignmentListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AssignmentListResultIterator provides access to a complete listing of Assignment values.
type AssignmentListResultIterator struct {
// contains filtered or unexported fields
}
func NewAssignmentListResultIterator(page AssignmentListResultPage) AssignmentListResultIterator
Creates a new instance of the AssignmentListResultIterator type.
func (iter *AssignmentListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AssignmentListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AssignmentListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AssignmentListResultIterator) Response() AssignmentListResult
Response returns the raw server response from the last page request.
func (iter AssignmentListResultIterator) Value() Assignment
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
AssignmentListResultPage contains a page of Assignment values.
type AssignmentListResultPage struct {
// contains filtered or unexported fields
}
func NewAssignmentListResultPage(cur AssignmentListResult, getNextPage func(context.Context, AssignmentListResult) (AssignmentListResult, error)) AssignmentListResultPage
Creates a new instance of the AssignmentListResultPage type.
func (page *AssignmentListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AssignmentListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AssignmentListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AssignmentListResultPage) Response() AssignmentListResult
Response returns the raw server response from the last page request.
func (page AssignmentListResultPage) Values() []Assignment
Values returns the slice of values for the current page or nil if there are no values.
AssignmentProperties the policy assignment properties.
type AssignmentProperties struct {
// DisplayName - The display name of the policy assignment.
DisplayName *string `json:"displayName,omitempty"`
// PolicyDefinitionID - The ID of the policy definition or policy set definition being assigned.
PolicyDefinitionID *string `json:"policyDefinitionId,omitempty"`
// Scope - READ-ONLY; The scope for the policy assignment.
Scope *string `json:"scope,omitempty"`
// NotScopes - The policy's excluded scopes.
NotScopes *[]string `json:"notScopes,omitempty"`
// Parameters - The parameter values for the assigned policy rule. The keys are the parameter names.
Parameters map[string]*ParameterValuesValue `json:"parameters"`
// Description - This message will be part of response in case of policy violation.
Description *string `json:"description,omitempty"`
// Metadata - The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
Metadata interface{} `json:"metadata,omitempty"`
// EnforcementMode - The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. Possible values include: 'EnforcementModeDefault', 'EnforcementModeDoNotEnforce'
EnforcementMode EnforcementMode `json:"enforcementMode,omitempty"`
// NonComplianceMessages - The messages that describe why a resource is non-compliant with the policy.
NonComplianceMessages *[]NonComplianceMessage `json:"nonComplianceMessages,omitempty"`
}
func (ap AssignmentProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AssignmentProperties.
AssignmentsClient is the client for the Assignments methods of the Policy service.
type AssignmentsClient struct {
BaseClient
}
func NewAssignmentsClient(subscriptionID string) AssignmentsClient
NewAssignmentsClient creates an instance of the AssignmentsClient client.
func NewAssignmentsClientWithBaseURI(baseURI string, subscriptionID string) AssignmentsClient
NewAssignmentsClientWithBaseURI creates an instance of the AssignmentsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AssignmentsClient) Create(ctx context.Context, scope string, policyAssignmentName string, parameters Assignment) (result Assignment, err 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. Parameters: scope - the scope of the policy assignment. 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}' policyAssignmentName - the name of the policy assignment. parameters - parameters for the policy assignment.
func (client AssignmentsClient) CreateByID(ctx context.Context, policyAssignmentID string, parameters Assignment) (result Assignment, err error)
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}'. Parameters: policyAssignmentID - the ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. parameters - parameters for policy assignment.
func (client AssignmentsClient) CreateByIDPreparer(ctx context.Context, policyAssignmentID string, parameters Assignment) (*http.Request, error)
CreateByIDPreparer prepares the CreateByID request.
func (client AssignmentsClient) CreateByIDResponder(resp *http.Response) (result Assignment, err error)
CreateByIDResponder handles the response to the CreateByID request. The method always closes the http.Response Body.
func (client AssignmentsClient) CreateByIDSender(req *http.Request) (*http.Response, error)
CreateByIDSender sends the CreateByID request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) CreatePreparer(ctx context.Context, scope string, policyAssignmentName string, parameters Assignment) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client AssignmentsClient) CreateResponder(resp *http.Response) (result Assignment, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client AssignmentsClient) CreateSender(req *http.Request) (*http.Response, error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) Delete(ctx context.Context, scope string, policyAssignmentName string) (result Assignment, err 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}'. Parameters: scope - the scope of the policy assignment. 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}' policyAssignmentName - the name of the policy assignment to delete.
func (client AssignmentsClient) DeleteByID(ctx context.Context, policyAssignmentID string) (result Assignment, err error)
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). Parameters: policyAssignmentID - the ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
func (client AssignmentsClient) DeleteByIDPreparer(ctx context.Context, policyAssignmentID string) (*http.Request, error)
DeleteByIDPreparer prepares the DeleteByID request.
func (client AssignmentsClient) DeleteByIDResponder(resp *http.Response) (result Assignment, err error)
DeleteByIDResponder handles the response to the DeleteByID request. The method always closes the http.Response Body.
func (client AssignmentsClient) DeleteByIDSender(req *http.Request) (*http.Response, error)
DeleteByIDSender sends the DeleteByID request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) DeletePreparer(ctx context.Context, scope string, policyAssignmentName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client AssignmentsClient) DeleteResponder(resp *http.Response) (result Assignment, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client AssignmentsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) Get(ctx context.Context, scope string, policyAssignmentName string) (result Assignment, err error)
Get this operation retrieves a single policy assignment, given its name and the scope it was created at. Parameters: scope - the scope of the policy assignment. 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}' policyAssignmentName - the name of the policy assignment to get.
func (client AssignmentsClient) GetByID(ctx context.Context, policyAssignmentID string) (result Assignment, err error)
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}'. Parameters: policyAssignmentID - the ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
func (client AssignmentsClient) GetByIDPreparer(ctx context.Context, policyAssignmentID string) (*http.Request, error)
GetByIDPreparer prepares the GetByID request.
func (client AssignmentsClient) GetByIDResponder(resp *http.Response) (result Assignment, err error)
GetByIDResponder handles the response to the GetByID request. The method always closes the http.Response Body.
func (client AssignmentsClient) GetByIDSender(req *http.Request) (*http.Response, error)
GetByIDSender sends the GetByID request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) GetPreparer(ctx context.Context, scope string, policyAssignmentName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AssignmentsClient) GetResponder(resp *http.Response) (result Assignment, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client AssignmentsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) List(ctx context.Context, filter string, top *int32) (result AssignmentListResultPage, err error)
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}. Parameters: filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client AssignmentsClient) ListComplete(ctx context.Context, filter string, top *int32) (result AssignmentListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client AssignmentsClient) ListForManagementGroup(ctx context.Context, managementGroupID string, filter string, top *int32) (result AssignmentListResultPage, err error)
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. Parameters: managementGroupID - the ID of the management group. filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client AssignmentsClient) ListForManagementGroupComplete(ctx context.Context, managementGroupID string, filter string, top *int32) (result AssignmentListResultIterator, err error)
ListForManagementGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client AssignmentsClient) ListForManagementGroupPreparer(ctx context.Context, managementGroupID string, filter string, top *int32) (*http.Request, error)
ListForManagementGroupPreparer prepares the ListForManagementGroup request.
func (client AssignmentsClient) ListForManagementGroupResponder(resp *http.Response) (result AssignmentListResult, err error)
ListForManagementGroupResponder handles the response to the ListForManagementGroup request. The method always closes the http.Response Body.
func (client AssignmentsClient) ListForManagementGroupSender(req *http.Request) (*http.Response, error)
ListForManagementGroupSender sends the ListForManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string, top *int32) (result AssignmentListResultPage, err error)
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'). Parameters: resourceGroupName - the name of the resource group containing the resource. resourceProviderNamespace - the namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines) parentResourcePath - the parent resource path. Use empty string if there is none. resourceType - the resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites). resourceName - the name of the resource. filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client AssignmentsClient) ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string, top *int32) (result AssignmentListResultIterator, err error)
ListForResourceComplete enumerates all values, automatically crossing page boundaries as required.
func (client AssignmentsClient) ListForResourceGroup(ctx context.Context, resourceGroupName string, filter string, top *int32) (result AssignmentListResultPage, err error)
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. Parameters: resourceGroupName - the name of the resource group that contains policy assignments. filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client AssignmentsClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string, top *int32) (result AssignmentListResultIterator, err error)
ListForResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client AssignmentsClient) ListForResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string, top *int32) (*http.Request, error)
ListForResourceGroupPreparer prepares the ListForResourceGroup request.
func (client AssignmentsClient) ListForResourceGroupResponder(resp *http.Response) (result AssignmentListResult, err error)
ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.
func (client AssignmentsClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)
ListForResourceGroupSender sends the ListForResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) ListForResourcePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string, top *int32) (*http.Request, error)
ListForResourcePreparer prepares the ListForResource request.
func (client AssignmentsClient) ListForResourceResponder(resp *http.Response) (result AssignmentListResult, err error)
ListForResourceResponder handles the response to the ListForResource request. The method always closes the http.Response Body.
func (client AssignmentsClient) ListForResourceSender(req *http.Request) (*http.Response, error)
ListForResourceSender sends the ListForResource request. The method will close the http.Response Body if it receives an error.
func (client AssignmentsClient) ListPreparer(ctx context.Context, filter string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client AssignmentsClient) ListResponder(resp *http.Response) (result AssignmentListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client AssignmentsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
BaseClient is the base client for Policy.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
CloudError an error response from a policy operation.
type CloudError struct {
Error *ErrorResponse `json:"error,omitempty"`
}
CreatedByType enumerates the values for created by type.
type CreatedByType string
const (
// CreatedByTypeApplication ...
CreatedByTypeApplication CreatedByType = "Application"
// CreatedByTypeKey ...
CreatedByTypeKey CreatedByType = "Key"
// CreatedByTypeManagedIdentity ...
CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
// CreatedByTypeUser ...
CreatedByTypeUser CreatedByType = "User"
)
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.
DataEffect the data effect definition.
type DataEffect struct {
// Name - The data effect name.
Name *string `json:"name,omitempty"`
// DetailsSchema - The data effect details schema.
DetailsSchema interface{} `json:"detailsSchema,omitempty"`
}
DataManifestCustomResourceFunctionDefinition the custom resource function definition.
type DataManifestCustomResourceFunctionDefinition struct {
// Name - The function name as it will appear in the policy rule. eg - 'vault'.
Name *string `json:"name,omitempty"`
// FullyQualifiedResourceType - The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'.
FullyQualifiedResourceType *string `json:"fullyQualifiedResourceType,omitempty"`
// DefaultProperties - 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"`
// AllowCustomProperties - 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"`
}
DataManifestResourceFunctionsDefinition the resource functions supported by a manifest
type DataManifestResourceFunctionsDefinition struct {
// Standard - The standard resource functions (subscription and/or resourceGroup).
Standard *[]string `json:"standard,omitempty"`
// Custom - An array of data manifest custom resource definition.
Custom *[]DataManifestCustomResourceFunctionDefinition `json:"custom,omitempty"`
}
DataPolicyManifest the data policy manifest.
type DataPolicyManifest struct {
autorest.Response `json:"-"`
// DataPolicyManifestProperties - The data policy manifest properties.
*DataPolicyManifestProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the data policy manifest.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the data policy manifest (it's the same as the Policy Mode).
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource (Microsoft.Authorization/dataPolicyManifests).
Type *string `json:"type,omitempty"`
}
func (dpm DataPolicyManifest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataPolicyManifest.
func (dpm *DataPolicyManifest) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DataPolicyManifest struct.
DataPolicyManifestListResult list of data policy manifests.
type DataPolicyManifestListResult struct {
autorest.Response `json:"-"`
// Value - An array of data policy manifests.
Value *[]DataPolicyManifest `json:"value,omitempty"`
// NextLink - The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (dpmlr DataPolicyManifestListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DataPolicyManifestListResultIterator provides access to a complete listing of DataPolicyManifest values.
type DataPolicyManifestListResultIterator struct {
// contains filtered or unexported fields
}
func NewDataPolicyManifestListResultIterator(page DataPolicyManifestListResultPage) DataPolicyManifestListResultIterator
Creates a new instance of the DataPolicyManifestListResultIterator type.
func (iter *DataPolicyManifestListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *DataPolicyManifestListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter DataPolicyManifestListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DataPolicyManifestListResultIterator) Response() DataPolicyManifestListResult
Response returns the raw server response from the last page request.
func (iter DataPolicyManifestListResultIterator) Value() DataPolicyManifest
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
DataPolicyManifestListResultPage contains a page of DataPolicyManifest values.
type DataPolicyManifestListResultPage struct {
// contains filtered or unexported fields
}
func NewDataPolicyManifestListResultPage(cur DataPolicyManifestListResult, getNextPage func(context.Context, DataPolicyManifestListResult) (DataPolicyManifestListResult, error)) DataPolicyManifestListResultPage
Creates a new instance of the DataPolicyManifestListResultPage type.
func (page *DataPolicyManifestListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DataPolicyManifestListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DataPolicyManifestListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DataPolicyManifestListResultPage) Response() DataPolicyManifestListResult
Response returns the raw server response from the last page request.
func (page DataPolicyManifestListResultPage) Values() []DataPolicyManifest
Values returns the slice of values for the current page or nil if there are no values.
DataPolicyManifestProperties the properties of the data policy manifest.
type DataPolicyManifestProperties struct {
// Namespaces - The list of namespaces for the data policy manifest.
Namespaces *[]string `json:"namespaces,omitempty"`
// PolicyMode - The policy mode of the data policy manifest.
PolicyMode *string `json:"policyMode,omitempty"`
// IsBuiltInOnly - A value indicating whether policy mode is allowed only in built-in definitions.
IsBuiltInOnly *bool `json:"isBuiltInOnly,omitempty"`
// ResourceTypeAliases - An array of resource type aliases.
ResourceTypeAliases *[]ResourceTypeAliases `json:"resourceTypeAliases,omitempty"`
// Effects - The effect definition.
Effects *[]DataEffect `json:"effects,omitempty"`
// FieldValues - The non-alias field accessor values that can be used in the policy rule.
FieldValues *[]string `json:"fieldValues,omitempty"`
// DataManifestResourceFunctionsDefinition - The resource functions definition specified in the data manifest.
*DataManifestResourceFunctionsDefinition `json:"resourceFunctions,omitempty"`
}
func (dpmp DataPolicyManifestProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataPolicyManifestProperties.
func (dpmp *DataPolicyManifestProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DataPolicyManifestProperties struct.
DataPolicyManifestsClient is the client for the DataPolicyManifests methods of the Policy service.
type DataPolicyManifestsClient struct {
BaseClient
}
func NewDataPolicyManifestsClient(subscriptionID string) DataPolicyManifestsClient
NewDataPolicyManifestsClient creates an instance of the DataPolicyManifestsClient client.
func NewDataPolicyManifestsClientWithBaseURI(baseURI string, subscriptionID string) DataPolicyManifestsClient
NewDataPolicyManifestsClientWithBaseURI creates an instance of the DataPolicyManifestsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DataPolicyManifestsClient) GetByPolicyMode(ctx context.Context, policyMode string) (result DataPolicyManifest, err error)
GetByPolicyMode this operation retrieves the data policy manifest with the given policy mode. Parameters: policyMode - the policy mode of the data policy manifest to get.
func (client DataPolicyManifestsClient) GetByPolicyModePreparer(ctx context.Context, policyMode string) (*http.Request, error)
GetByPolicyModePreparer prepares the GetByPolicyMode request.
func (client DataPolicyManifestsClient) GetByPolicyModeResponder(resp *http.Response) (result DataPolicyManifest, err error)
GetByPolicyModeResponder handles the response to the GetByPolicyMode request. The method always closes the http.Response Body.
func (client DataPolicyManifestsClient) GetByPolicyModeSender(req *http.Request) (*http.Response, error)
GetByPolicyModeSender sends the GetByPolicyMode request. The method will close the http.Response Body if it receives an error.
func (client DataPolicyManifestsClient) List(ctx context.Context, filter string) (result DataPolicyManifestListResultPage, err error)
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. Parameters: filter - 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.
func (client DataPolicyManifestsClient) ListComplete(ctx context.Context, filter string) (result DataPolicyManifestListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client DataPolicyManifestsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)
ListPreparer prepares the List request.
func (client DataPolicyManifestsClient) ListResponder(resp *http.Response) (result DataPolicyManifestListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client DataPolicyManifestsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
Definition the policy definition.
type Definition struct {
autorest.Response `json:"-"`
// DefinitionProperties - The policy definition properties.
*DefinitionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the policy definition.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the policy definition.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource (Microsoft.Authorization/policyDefinitions).
Type *string `json:"type,omitempty"`
}
func (d Definition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Definition.
func (d *Definition) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Definition struct.
DefinitionGroup the policy definition group.
type DefinitionGroup struct {
// Name - The name of the group.
Name *string `json:"name,omitempty"`
// DisplayName - The group's display name.
DisplayName *string `json:"displayName,omitempty"`
// Category - The group's category.
Category *string `json:"category,omitempty"`
// Description - The group's description.
Description *string `json:"description,omitempty"`
// AdditionalMetadataID - A resource ID of a resource that contains additional metadata about the group.
AdditionalMetadataID *string `json:"additionalMetadataId,omitempty"`
}
DefinitionListResult list of policy definitions.
type DefinitionListResult struct {
autorest.Response `json:"-"`
// Value - An array of policy definitions.
Value *[]Definition `json:"value,omitempty"`
// NextLink - The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (dlr DefinitionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DefinitionListResultIterator provides access to a complete listing of Definition values.
type DefinitionListResultIterator struct {
// contains filtered or unexported fields
}
func NewDefinitionListResultIterator(page DefinitionListResultPage) DefinitionListResultIterator
Creates a new instance of the DefinitionListResultIterator type.
func (iter *DefinitionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *DefinitionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter DefinitionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DefinitionListResultIterator) Response() DefinitionListResult
Response returns the raw server response from the last page request.
func (iter DefinitionListResultIterator) Value() Definition
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
DefinitionListResultPage contains a page of Definition values.
type DefinitionListResultPage struct {
// contains filtered or unexported fields
}
func NewDefinitionListResultPage(cur DefinitionListResult, getNextPage func(context.Context, DefinitionListResult) (DefinitionListResult, error)) DefinitionListResultPage
Creates a new instance of the DefinitionListResultPage type.
func (page *DefinitionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DefinitionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DefinitionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DefinitionListResultPage) Response() DefinitionListResult
Response returns the raw server response from the last page request.
func (page DefinitionListResultPage) Values() []Definition
Values returns the slice of values for the current page or nil if there are no values.
DefinitionProperties the policy definition properties.
type DefinitionProperties struct {
// PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Possible values include: 'TypeNotSpecified', 'TypeBuiltIn', 'TypeCustom', 'TypeStatic'
PolicyType Type `json:"policyType,omitempty"`
// Mode - The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
Mode *string `json:"mode,omitempty"`
// DisplayName - The display name of the policy definition.
DisplayName *string `json:"displayName,omitempty"`
// Description - The policy definition description.
Description *string `json:"description,omitempty"`
// PolicyRule - The policy rule.
PolicyRule interface{} `json:"policyRule,omitempty"`
// Metadata - The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
Metadata interface{} `json:"metadata,omitempty"`
// Parameters - The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
Parameters map[string]*ParameterDefinitionsValue `json:"parameters"`
}
func (dp DefinitionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DefinitionProperties.
DefinitionReference the policy definition reference.
type DefinitionReference struct {
// PolicyDefinitionID - The ID of the policy definition or policy set definition.
PolicyDefinitionID *string `json:"policyDefinitionId,omitempty"`
// Parameters - The parameter values for the referenced policy rule. The keys are the parameter names.
Parameters map[string]*ParameterValuesValue `json:"parameters"`
// PolicyDefinitionReferenceID - A unique id (within the policy set definition) for this policy definition reference.
PolicyDefinitionReferenceID *string `json:"policyDefinitionReferenceId,omitempty"`
// GroupNames - The name of the groups that this policy definition reference belongs to.
GroupNames *[]string `json:"groupNames,omitempty"`
}
func (dr DefinitionReference) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DefinitionReference.
DefinitionsClient is the client for the Definitions methods of the Policy service.
type DefinitionsClient struct {
BaseClient
}
func NewDefinitionsClient(subscriptionID string) DefinitionsClient
NewDefinitionsClient creates an instance of the DefinitionsClient client.
func NewDefinitionsClientWithBaseURI(baseURI string, subscriptionID string) DefinitionsClient
NewDefinitionsClientWithBaseURI creates an instance of the DefinitionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DefinitionsClient) CreateOrUpdate(ctx context.Context, policyDefinitionName string, parameters Definition) (result Definition, err error)
CreateOrUpdate this operation creates or updates a policy definition in the given subscription with the given name. Parameters: policyDefinitionName - the name of the policy definition to create. parameters - the policy definition properties.
func (client DefinitionsClient) CreateOrUpdateAtManagementGroup(ctx context.Context, policyDefinitionName string, parameters Definition, managementGroupID string) (result Definition, err error)
CreateOrUpdateAtManagementGroup this operation creates or updates a policy definition in the given management group with the given name. Parameters: policyDefinitionName - the name of the policy definition to create. parameters - the policy definition properties. managementGroupID - the ID of the management group.
func (client DefinitionsClient) CreateOrUpdateAtManagementGroupPreparer(ctx context.Context, policyDefinitionName string, parameters Definition, managementGroupID string) (*http.Request, error)
CreateOrUpdateAtManagementGroupPreparer prepares the CreateOrUpdateAtManagementGroup request.
func (client DefinitionsClient) CreateOrUpdateAtManagementGroupResponder(resp *http.Response) (result Definition, err error)
CreateOrUpdateAtManagementGroupResponder handles the response to the CreateOrUpdateAtManagementGroup request. The method always closes the http.Response Body.
func (client DefinitionsClient) CreateOrUpdateAtManagementGroupSender(req *http.Request) (*http.Response, error)
CreateOrUpdateAtManagementGroupSender sends the CreateOrUpdateAtManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) CreateOrUpdatePreparer(ctx context.Context, policyDefinitionName string, parameters Definition) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DefinitionsClient) CreateOrUpdateResponder(resp *http.Response) (result Definition, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DefinitionsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) Delete(ctx context.Context, policyDefinitionName string) (result autorest.Response, err error)
Delete this operation deletes the policy definition in the given subscription with the given name. Parameters: policyDefinitionName - the name of the policy definition to delete.
func (client DefinitionsClient) DeleteAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string) (result autorest.Response, err error)
DeleteAtManagementGroup this operation deletes the policy definition in the given management group with the given name. Parameters: policyDefinitionName - the name of the policy definition to delete. managementGroupID - the ID of the management group.
func (client DefinitionsClient) DeleteAtManagementGroupPreparer(ctx context.Context, policyDefinitionName string, managementGroupID string) (*http.Request, error)
DeleteAtManagementGroupPreparer prepares the DeleteAtManagementGroup request.
func (client DefinitionsClient) DeleteAtManagementGroupResponder(resp *http.Response) (result autorest.Response, err error)
DeleteAtManagementGroupResponder handles the response to the DeleteAtManagementGroup request. The method always closes the http.Response Body.
func (client DefinitionsClient) DeleteAtManagementGroupSender(req *http.Request) (*http.Response, error)
DeleteAtManagementGroupSender sends the DeleteAtManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) DeletePreparer(ctx context.Context, policyDefinitionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DefinitionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DefinitionsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) Get(ctx context.Context, policyDefinitionName string) (result Definition, err error)
Get this operation retrieves the policy definition in the given subscription with the given name. Parameters: policyDefinitionName - the name of the policy definition to get.
func (client DefinitionsClient) GetAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string) (result Definition, err error)
GetAtManagementGroup this operation retrieves the policy definition in the given management group with the given name. Parameters: policyDefinitionName - the name of the policy definition to get. managementGroupID - the ID of the management group.
func (client DefinitionsClient) GetAtManagementGroupPreparer(ctx context.Context, policyDefinitionName string, managementGroupID string) (*http.Request, error)
GetAtManagementGroupPreparer prepares the GetAtManagementGroup request.
func (client DefinitionsClient) GetAtManagementGroupResponder(resp *http.Response) (result Definition, err error)
GetAtManagementGroupResponder handles the response to the GetAtManagementGroup request. The method always closes the http.Response Body.
func (client DefinitionsClient) GetAtManagementGroupSender(req *http.Request) (*http.Response, error)
GetAtManagementGroupSender sends the GetAtManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) GetBuiltIn(ctx context.Context, policyDefinitionName string) (result Definition, err error)
GetBuiltIn this operation retrieves the built-in policy definition with the given name. Parameters: policyDefinitionName - the name of the built-in policy definition to get.
func (client DefinitionsClient) GetBuiltInPreparer(ctx context.Context, policyDefinitionName string) (*http.Request, error)
GetBuiltInPreparer prepares the GetBuiltIn request.
func (client DefinitionsClient) GetBuiltInResponder(resp *http.Response) (result Definition, err error)
GetBuiltInResponder handles the response to the GetBuiltIn request. The method always closes the http.Response Body.
func (client DefinitionsClient) GetBuiltInSender(req *http.Request) (*http.Response, error)
GetBuiltInSender sends the GetBuiltIn request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) GetPreparer(ctx context.Context, policyDefinitionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DefinitionsClient) GetResponder(resp *http.Response) (result Definition, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DefinitionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) List(ctx context.Context, filter string, top *int32) (result DefinitionListResultPage, err error)
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}. Parameters: filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client DefinitionsClient) ListBuiltIn(ctx context.Context, filter string, top *int32) (result DefinitionListResultPage, err error)
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}. Parameters: filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client DefinitionsClient) ListBuiltInComplete(ctx context.Context, filter string, top *int32) (result DefinitionListResultIterator, err error)
ListBuiltInComplete enumerates all values, automatically crossing page boundaries as required.
func (client DefinitionsClient) ListBuiltInPreparer(ctx context.Context, filter string, top *int32) (*http.Request, error)
ListBuiltInPreparer prepares the ListBuiltIn request.
func (client DefinitionsClient) ListBuiltInResponder(resp *http.Response) (result DefinitionListResult, err error)
ListBuiltInResponder handles the response to the ListBuiltIn request. The method always closes the http.Response Body.
func (client DefinitionsClient) ListBuiltInSender(req *http.Request) (*http.Response, error)
ListBuiltInSender sends the ListBuiltIn request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) ListByManagementGroup(ctx context.Context, managementGroupID string, filter string, top *int32) (result DefinitionListResultPage, err error)
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}. Parameters: managementGroupID - the ID of the management group. filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client DefinitionsClient) ListByManagementGroupComplete(ctx context.Context, managementGroupID string, filter string, top *int32) (result DefinitionListResultIterator, err error)
ListByManagementGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DefinitionsClient) ListByManagementGroupPreparer(ctx context.Context, managementGroupID string, filter string, top *int32) (*http.Request, error)
ListByManagementGroupPreparer prepares the ListByManagementGroup request.
func (client DefinitionsClient) ListByManagementGroupResponder(resp *http.Response) (result DefinitionListResult, err error)
ListByManagementGroupResponder handles the response to the ListByManagementGroup request. The method always closes the http.Response Body.
func (client DefinitionsClient) ListByManagementGroupSender(req *http.Request) (*http.Response, error)
ListByManagementGroupSender sends the ListByManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client DefinitionsClient) ListComplete(ctx context.Context, filter string, top *int32) (result DefinitionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client DefinitionsClient) ListPreparer(ctx context.Context, filter string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client DefinitionsClient) ListResponder(resp *http.Response) (result DefinitionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client DefinitionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
EnforcementMode enumerates the values for enforcement mode.
type EnforcementMode string
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() []EnforcementMode
PossibleEnforcementModeValues returns an array of possible values for the EnforcementMode const type.
ErrorAdditionalInfo the resource management error additional info.
type ErrorAdditionalInfo struct {
// Type - READ-ONLY; The additional info type.
Type *string `json:"type,omitempty"`
// Info - READ-ONLY; The additional info.
Info interface{} `json:"info,omitempty"`
}
func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorAdditionalInfo.
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.)
type ErrorResponse struct {
// Code - READ-ONLY; The error code.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"message,omitempty"`
// Target - READ-ONLY; The error target.
Target *string `json:"target,omitempty"`
// Details - READ-ONLY; The error details.
Details *[]ErrorResponse `json:"details,omitempty"`
// AdditionalInfo - READ-ONLY; The error additional info.
AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}
func (er ErrorResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorResponse.
Exemption the policy exemption.
type Exemption struct {
autorest.Response `json:"-"`
// ExemptionProperties - Properties for the policy exemption.
*ExemptionProperties `json:"properties,omitempty"`
// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData `json:"systemData,omitempty"`
// ID - READ-ONLY; The ID of the policy exemption.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the policy exemption.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource (Microsoft.Authorization/policyExemptions).
Type *string `json:"type,omitempty"`
}
func (e Exemption) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Exemption.
func (e *Exemption) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Exemption struct.
ExemptionCategory enumerates the values for exemption category.
type ExemptionCategory string
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() []ExemptionCategory
PossibleExemptionCategoryValues returns an array of possible values for the ExemptionCategory const type.
ExemptionListResult list of policy exemptions.
type ExemptionListResult struct {
autorest.Response `json:"-"`
// Value - An array of policy exemptions.
Value *[]Exemption `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (elr ExemptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (elr ExemptionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExemptionListResult.
ExemptionListResultIterator provides access to a complete listing of Exemption values.
type ExemptionListResultIterator struct {
// contains filtered or unexported fields
}
func NewExemptionListResultIterator(page ExemptionListResultPage) ExemptionListResultIterator
Creates a new instance of the ExemptionListResultIterator type.
func (iter *ExemptionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ExemptionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ExemptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExemptionListResultIterator) Response() ExemptionListResult
Response returns the raw server response from the last page request.
func (iter ExemptionListResultIterator) Value() Exemption
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ExemptionListResultPage contains a page of Exemption values.
type ExemptionListResultPage struct {
// contains filtered or unexported fields
}
func NewExemptionListResultPage(cur ExemptionListResult, getNextPage func(context.Context, ExemptionListResult) (ExemptionListResult, error)) ExemptionListResultPage
Creates a new instance of the ExemptionListResultPage type.
func (page *ExemptionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ExemptionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ExemptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExemptionListResultPage) Response() ExemptionListResult
Response returns the raw server response from the last page request.
func (page ExemptionListResultPage) Values() []Exemption
Values returns the slice of values for the current page or nil if there are no values.
ExemptionProperties the policy exemption properties.
type ExemptionProperties struct {
// PolicyAssignmentID - The ID of the policy assignment that is being exempted.
PolicyAssignmentID *string `json:"policyAssignmentId,omitempty"`
// PolicyDefinitionReferenceIds - The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
PolicyDefinitionReferenceIds *[]string `json:"policyDefinitionReferenceIds,omitempty"`
// ExemptionCategory - The policy exemption category. Possible values are Waiver and Mitigated. Possible values include: 'ExemptionCategoryWaiver', 'ExemptionCategoryMitigated'
ExemptionCategory ExemptionCategory `json:"exemptionCategory,omitempty"`
// ExpiresOn - The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
ExpiresOn *date.Time `json:"expiresOn,omitempty"`
// DisplayName - The display name of the policy exemption.
DisplayName *string `json:"displayName,omitempty"`
// Description - The description of the policy exemption.
Description *string `json:"description,omitempty"`
// Metadata - The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
Metadata interface{} `json:"metadata,omitempty"`
}
ExemptionsClient is the client for the Exemptions methods of the Policy service.
type ExemptionsClient struct {
BaseClient
}
func NewExemptionsClient(subscriptionID string) ExemptionsClient
NewExemptionsClient creates an instance of the ExemptionsClient client.
func NewExemptionsClientWithBaseURI(baseURI string, subscriptionID string) ExemptionsClient
NewExemptionsClientWithBaseURI creates an instance of the ExemptionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ExemptionsClient) CreateOrUpdate(ctx context.Context, scope string, policyExemptionName string, parameters Exemption) (result Exemption, err 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. Parameters: scope - the scope of the policy exemption. 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}' policyExemptionName - the name of the policy exemption to delete. parameters - parameters for the policy exemption.
func (client ExemptionsClient) CreateOrUpdatePreparer(ctx context.Context, scope string, policyExemptionName string, parameters Exemption) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ExemptionsClient) CreateOrUpdateResponder(resp *http.Response) (result Exemption, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ExemptionsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ExemptionsClient) Delete(ctx context.Context, scope string, policyExemptionName string) (result autorest.Response, err 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}'. Parameters: scope - the scope of the policy exemption. 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}' policyExemptionName - the name of the policy exemption to delete.
func (client ExemptionsClient) DeletePreparer(ctx context.Context, scope string, policyExemptionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ExemptionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ExemptionsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ExemptionsClient) Get(ctx context.Context, scope string, policyExemptionName string) (result Exemption, err error)
Get this operation retrieves a single policy exemption, given its name and the scope it was created at. Parameters: scope - the scope of the policy exemption. 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}' policyExemptionName - the name of the policy exemption to delete.
func (client ExemptionsClient) GetPreparer(ctx context.Context, scope string, policyExemptionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ExemptionsClient) GetResponder(resp *http.Response) (result Exemption, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ExemptionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ExemptionsClient) List(ctx context.Context, filter string) (result ExemptionListResultPage, err error)
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. Parameters: filter - 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.
func (client ExemptionsClient) ListComplete(ctx context.Context, filter string) (result ExemptionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExemptionsClient) ListForManagementGroup(ctx context.Context, managementGroupID string, filter string) (result ExemptionListResultPage, err error)
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. Parameters: managementGroupID - the ID of the management group. filter - 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.
func (client ExemptionsClient) ListForManagementGroupComplete(ctx context.Context, managementGroupID string, filter string) (result ExemptionListResultIterator, err error)
ListForManagementGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExemptionsClient) ListForManagementGroupPreparer(ctx context.Context, managementGroupID string, filter string) (*http.Request, error)
ListForManagementGroupPreparer prepares the ListForManagementGroup request.
func (client ExemptionsClient) ListForManagementGroupResponder(resp *http.Response) (result ExemptionListResult, err error)
ListForManagementGroupResponder handles the response to the ListForManagementGroup request. The method always closes the http.Response Body.
func (client ExemptionsClient) ListForManagementGroupSender(req *http.Request) (*http.Response, error)
ListForManagementGroupSender sends the ListForManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client ExemptionsClient) ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result ExemptionListResultPage, err error)
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'). Parameters: resourceGroupName - the name of the resource group containing the resource. resourceProviderNamespace - the namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines) parentResourcePath - the parent resource path. Use empty string if there is none. resourceType - the resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites). resourceName - the name of the resource. filter - 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.
func (client ExemptionsClient) ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result ExemptionListResultIterator, err error)
ListForResourceComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExemptionsClient) ListForResourceGroup(ctx context.Context, resourceGroupName string, filter string) (result ExemptionListResultPage, err error)
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. Parameters: resourceGroupName - the name of the resource group containing the resource. filter - 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.
func (client ExemptionsClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string) (result ExemptionListResultIterator, err error)
ListForResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExemptionsClient) ListForResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string) (*http.Request, error)
ListForResourceGroupPreparer prepares the ListForResourceGroup request.
func (client ExemptionsClient) ListForResourceGroupResponder(resp *http.Response) (result ExemptionListResult, err error)
ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.
func (client ExemptionsClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)
ListForResourceGroupSender sends the ListForResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ExemptionsClient) ListForResourcePreparer(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (*http.Request, error)
ListForResourcePreparer prepares the ListForResource request.
func (client ExemptionsClient) ListForResourceResponder(resp *http.Response) (result ExemptionListResult, err error)
ListForResourceResponder handles the response to the ListForResource request. The method always closes the http.Response Body.
func (client ExemptionsClient) ListForResourceSender(req *http.Request) (*http.Response, error)
ListForResourceSender sends the ListForResource request. The method will close the http.Response Body if it receives an error.
func (client ExemptionsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ExemptionsClient) ListResponder(resp *http.Response) (result ExemptionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ExemptionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
Identity identity for the resource.
type Identity struct {
// PrincipalID - READ-ONLY; The principal ID of the resource identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant ID of the resource identity.
TenantID *string `json:"tenantId,omitempty"`
// Type - The identity type. This is the only required field when adding a system assigned identity to a resource. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeNone'
Type ResourceIdentityType `json:"type,omitempty"`
}
func (i Identity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Identity.
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 NonComplianceMessage struct {
// Message - 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"`
// PolicyDefinitionReferenceID - 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"`
}
ParameterDefinitionsValue the definition of a parameter that can be provided to the policy.
type ParameterDefinitionsValue struct {
// Type - The data type of the parameter. Possible values include: 'ParameterTypeString', 'ParameterTypeArray', 'ParameterTypeObject', 'ParameterTypeBoolean', 'ParameterTypeInteger', 'ParameterTypeFloat', 'ParameterTypeDateTime'
Type ParameterType `json:"type,omitempty"`
// AllowedValues - The allowed values for the parameter.
AllowedValues *[]interface{} `json:"allowedValues,omitempty"`
// DefaultValue - The default value for the parameter if no value is provided.
DefaultValue interface{} `json:"defaultValue,omitempty"`
// Metadata - General metadata for the parameter.
Metadata *ParameterDefinitionsValueMetadata `json:"metadata,omitempty"`
}
ParameterDefinitionsValueMetadata general metadata for the parameter.
type ParameterDefinitionsValueMetadata struct {
// AdditionalProperties - Unmatched properties from the message are deserialized this collection
AdditionalProperties map[string]interface{} `json:""`
// DisplayName - The display name for the parameter.
DisplayName *string `json:"displayName,omitempty"`
// Description - The description of the parameter.
Description *string `json:"description,omitempty"`
// StrongType - 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"`
// AssignPermissions - 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"`
}
func (pdv ParameterDefinitionsValueMetadata) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ParameterDefinitionsValueMetadata.
func (pdv *ParameterDefinitionsValueMetadata) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ParameterDefinitionsValueMetadata struct.
ParameterType enumerates the values for parameter type.
type ParameterType string
const (
// ParameterTypeArray ...
ParameterTypeArray ParameterType = "Array"
// ParameterTypeBoolean ...
ParameterTypeBoolean ParameterType = "Boolean"
// ParameterTypeDateTime ...
ParameterTypeDateTime ParameterType = "DateTime"
// ParameterTypeFloat ...
ParameterTypeFloat ParameterType = "Float"
// ParameterTypeInteger ...
ParameterTypeInteger ParameterType = "Integer"
// ParameterTypeObject ...
ParameterTypeObject ParameterType = "Object"
// ParameterTypeString ...
ParameterTypeString ParameterType = "String"
)
func PossibleParameterTypeValues() []ParameterType
PossibleParameterTypeValues returns an array of possible values for the ParameterType const type.
ParameterValuesValue the value of a parameter.
type ParameterValuesValue struct {
// Value - The value of the parameter.
Value interface{} `json:"value,omitempty"`
}
ResourceIdentityType enumerates the values for resource identity type.
type ResourceIdentityType string
const (
// ResourceIdentityTypeNone Indicates that no identity is associated with the resource or that the existing
// identity should be removed.
ResourceIdentityTypeNone ResourceIdentityType = "None"
// ResourceIdentityTypeSystemAssigned Indicates that a system assigned identity is associated with the
// resource.
ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
)
func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
ResourceTypeAliases the resource type aliases definition.
type ResourceTypeAliases struct {
// ResourceType - The resource type name.
ResourceType *string `json:"resourceType,omitempty"`
// Aliases - The aliases for property names.
Aliases *[]Alias `json:"aliases,omitempty"`
}
SetDefinition the policy set definition.
type SetDefinition struct {
autorest.Response `json:"-"`
// SetDefinitionProperties - The policy definition properties.
*SetDefinitionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the policy set definition.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the policy set definition.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource (Microsoft.Authorization/policySetDefinitions).
Type *string `json:"type,omitempty"`
}
func (sd SetDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SetDefinition.
func (sd *SetDefinition) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SetDefinition struct.
SetDefinitionListResult list of policy set definitions.
type SetDefinitionListResult struct {
autorest.Response `json:"-"`
// Value - An array of policy set definitions.
Value *[]SetDefinition `json:"value,omitempty"`
// NextLink - The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (sdlr SetDefinitionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SetDefinitionListResultIterator provides access to a complete listing of SetDefinition values.
type SetDefinitionListResultIterator struct {
// contains filtered or unexported fields
}
func NewSetDefinitionListResultIterator(page SetDefinitionListResultPage) SetDefinitionListResultIterator
Creates a new instance of the SetDefinitionListResultIterator type.
func (iter *SetDefinitionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *SetDefinitionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SetDefinitionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SetDefinitionListResultIterator) Response() SetDefinitionListResult
Response returns the raw server response from the last page request.
func (iter SetDefinitionListResultIterator) Value() SetDefinition
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SetDefinitionListResultPage contains a page of SetDefinition values.
type SetDefinitionListResultPage struct {
// contains filtered or unexported fields
}
func NewSetDefinitionListResultPage(cur SetDefinitionListResult, getNextPage func(context.Context, SetDefinitionListResult) (SetDefinitionListResult, error)) SetDefinitionListResultPage
Creates a new instance of the SetDefinitionListResultPage type.
func (page *SetDefinitionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *SetDefinitionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page SetDefinitionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SetDefinitionListResultPage) Response() SetDefinitionListResult
Response returns the raw server response from the last page request.
func (page SetDefinitionListResultPage) Values() []SetDefinition
Values returns the slice of values for the current page or nil if there are no values.
SetDefinitionProperties the policy set definition properties.
type SetDefinitionProperties struct {
// PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Possible values include: 'TypeNotSpecified', 'TypeBuiltIn', 'TypeCustom', 'TypeStatic'
PolicyType Type `json:"policyType,omitempty"`
// DisplayName - The display name of the policy set definition.
DisplayName *string `json:"displayName,omitempty"`
// Description - The policy set definition description.
Description *string `json:"description,omitempty"`
// Metadata - The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
Metadata interface{} `json:"metadata,omitempty"`
// Parameters - The policy set definition parameters that can be used in policy definition references.
Parameters map[string]*ParameterDefinitionsValue `json:"parameters"`
// PolicyDefinitions - An array of policy definition references.
PolicyDefinitions *[]DefinitionReference `json:"policyDefinitions,omitempty"`
// PolicyDefinitionGroups - The metadata describing groups of policy definition references within the policy set definition.
PolicyDefinitionGroups *[]DefinitionGroup `json:"policyDefinitionGroups,omitempty"`
}
func (sdp SetDefinitionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SetDefinitionProperties.
SetDefinitionsClient is the client for the SetDefinitions methods of the Policy service.
type SetDefinitionsClient struct {
BaseClient
}
func NewSetDefinitionsClient(subscriptionID string) SetDefinitionsClient
NewSetDefinitionsClient creates an instance of the SetDefinitionsClient client.
func NewSetDefinitionsClientWithBaseURI(baseURI string, subscriptionID string) SetDefinitionsClient
NewSetDefinitionsClientWithBaseURI creates an instance of the SetDefinitionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client SetDefinitionsClient) CreateOrUpdate(ctx context.Context, policySetDefinitionName string, parameters SetDefinition) (result SetDefinition, err error)
CreateOrUpdate this operation creates or updates a policy set definition in the given subscription with the given name. Parameters: policySetDefinitionName - the name of the policy set definition to create. parameters - the policy set definition properties.
func (client SetDefinitionsClient) CreateOrUpdateAtManagementGroup(ctx context.Context, policySetDefinitionName string, parameters SetDefinition, managementGroupID string) (result SetDefinition, err error)
CreateOrUpdateAtManagementGroup this operation creates or updates a policy set definition in the given management group with the given name. Parameters: policySetDefinitionName - the name of the policy set definition to create. parameters - the policy set definition properties. managementGroupID - the ID of the management group.
func (client SetDefinitionsClient) CreateOrUpdateAtManagementGroupPreparer(ctx context.Context, policySetDefinitionName string, parameters SetDefinition, managementGroupID string) (*http.Request, error)
CreateOrUpdateAtManagementGroupPreparer prepares the CreateOrUpdateAtManagementGroup request.
func (client SetDefinitionsClient) CreateOrUpdateAtManagementGroupResponder(resp *http.Response) (result SetDefinition, err error)
CreateOrUpdateAtManagementGroupResponder handles the response to the CreateOrUpdateAtManagementGroup request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) CreateOrUpdateAtManagementGroupSender(req *http.Request) (*http.Response, error)
CreateOrUpdateAtManagementGroupSender sends the CreateOrUpdateAtManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) CreateOrUpdatePreparer(ctx context.Context, policySetDefinitionName string, parameters SetDefinition) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SetDefinitionsClient) CreateOrUpdateResponder(resp *http.Response) (result SetDefinition, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) Delete(ctx context.Context, policySetDefinitionName string) (result autorest.Response, err error)
Delete this operation deletes the policy set definition in the given subscription with the given name. Parameters: policySetDefinitionName - the name of the policy set definition to delete.
func (client SetDefinitionsClient) DeleteAtManagementGroup(ctx context.Context, policySetDefinitionName string, managementGroupID string) (result autorest.Response, err error)
DeleteAtManagementGroup this operation deletes the policy set definition in the given management group with the given name. Parameters: policySetDefinitionName - the name of the policy set definition to delete. managementGroupID - the ID of the management group.
func (client SetDefinitionsClient) DeleteAtManagementGroupPreparer(ctx context.Context, policySetDefinitionName string, managementGroupID string) (*http.Request, error)
DeleteAtManagementGroupPreparer prepares the DeleteAtManagementGroup request.
func (client SetDefinitionsClient) DeleteAtManagementGroupResponder(resp *http.Response) (result autorest.Response, err error)
DeleteAtManagementGroupResponder handles the response to the DeleteAtManagementGroup request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) DeleteAtManagementGroupSender(req *http.Request) (*http.Response, error)
DeleteAtManagementGroupSender sends the DeleteAtManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) DeletePreparer(ctx context.Context, policySetDefinitionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SetDefinitionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) Get(ctx context.Context, policySetDefinitionName string) (result SetDefinition, err error)
Get this operation retrieves the policy set definition in the given subscription with the given name. Parameters: policySetDefinitionName - the name of the policy set definition to get.
func (client SetDefinitionsClient) GetAtManagementGroup(ctx context.Context, policySetDefinitionName string, managementGroupID string) (result SetDefinition, err error)
GetAtManagementGroup this operation retrieves the policy set definition in the given management group with the given name. Parameters: policySetDefinitionName - the name of the policy set definition to get. managementGroupID - the ID of the management group.
func (client SetDefinitionsClient) GetAtManagementGroupPreparer(ctx context.Context, policySetDefinitionName string, managementGroupID string) (*http.Request, error)
GetAtManagementGroupPreparer prepares the GetAtManagementGroup request.
func (client SetDefinitionsClient) GetAtManagementGroupResponder(resp *http.Response) (result SetDefinition, err error)
GetAtManagementGroupResponder handles the response to the GetAtManagementGroup request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) GetAtManagementGroupSender(req *http.Request) (*http.Response, error)
GetAtManagementGroupSender sends the GetAtManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) GetBuiltIn(ctx context.Context, policySetDefinitionName string) (result SetDefinition, err error)
GetBuiltIn this operation retrieves the built-in policy set definition with the given name. Parameters: policySetDefinitionName - the name of the policy set definition to get.
func (client SetDefinitionsClient) GetBuiltInPreparer(ctx context.Context, policySetDefinitionName string) (*http.Request, error)
GetBuiltInPreparer prepares the GetBuiltIn request.
func (client SetDefinitionsClient) GetBuiltInResponder(resp *http.Response) (result SetDefinition, err error)
GetBuiltInResponder handles the response to the GetBuiltIn request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) GetBuiltInSender(req *http.Request) (*http.Response, error)
GetBuiltInSender sends the GetBuiltIn request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) GetPreparer(ctx context.Context, policySetDefinitionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SetDefinitionsClient) GetResponder(resp *http.Response) (result SetDefinition, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) List(ctx context.Context, filter string, top *int32) (result SetDefinitionListResultPage, err error)
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}. Parameters: filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client SetDefinitionsClient) ListBuiltIn(ctx context.Context, filter string, top *int32) (result SetDefinitionListResultPage, err error)
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}. Parameters: filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client SetDefinitionsClient) ListBuiltInComplete(ctx context.Context, filter string, top *int32) (result SetDefinitionListResultIterator, err error)
ListBuiltInComplete enumerates all values, automatically crossing page boundaries as required.
func (client SetDefinitionsClient) ListBuiltInPreparer(ctx context.Context, filter string, top *int32) (*http.Request, error)
ListBuiltInPreparer prepares the ListBuiltIn request.
func (client SetDefinitionsClient) ListBuiltInResponder(resp *http.Response) (result SetDefinitionListResult, err error)
ListBuiltInResponder handles the response to the ListBuiltIn request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) ListBuiltInSender(req *http.Request) (*http.Response, error)
ListBuiltInSender sends the ListBuiltIn request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) ListByManagementGroup(ctx context.Context, managementGroupID string, filter string, top *int32) (result SetDefinitionListResultPage, err error)
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}. Parameters: managementGroupID - the ID of the management group. filter - 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}. top - maximum number of records to return. When the $top filter is not provided, it will return 500 records.
func (client SetDefinitionsClient) ListByManagementGroupComplete(ctx context.Context, managementGroupID string, filter string, top *int32) (result SetDefinitionListResultIterator, err error)
ListByManagementGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client SetDefinitionsClient) ListByManagementGroupPreparer(ctx context.Context, managementGroupID string, filter string, top *int32) (*http.Request, error)
ListByManagementGroupPreparer prepares the ListByManagementGroup request.
func (client SetDefinitionsClient) ListByManagementGroupResponder(resp *http.Response) (result SetDefinitionListResult, err error)
ListByManagementGroupResponder handles the response to the ListByManagementGroup request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) ListByManagementGroupSender(req *http.Request) (*http.Response, error)
ListByManagementGroupSender sends the ListByManagementGroup request. The method will close the http.Response Body if it receives an error.
func (client SetDefinitionsClient) ListComplete(ctx context.Context, filter string, top *int32) (result SetDefinitionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SetDefinitionsClient) ListPreparer(ctx context.Context, filter string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client SetDefinitionsClient) ListResponder(resp *http.Response) (result SetDefinitionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SetDefinitionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
SystemData metadata pertaining to creation and last modification of the resource.
type SystemData struct {
// CreatedBy - The identity that created the resource.
CreatedBy *string `json:"createdBy,omitempty"`
// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
CreatedByType CreatedByType `json:"createdByType,omitempty"`
// CreatedAt - The timestamp of resource creation (UTC).
CreatedAt *date.Time `json:"createdAt,omitempty"`
// LastModifiedBy - The identity that last modified the resource.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
// LastModifiedAt - The timestamp of resource last modification (UTC)
LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}
Type enumerates the values for type.
type Type string
const (
// TypeBuiltIn ...
TypeBuiltIn Type = "BuiltIn"
// TypeCustom ...
TypeCustom Type = "Custom"
// TypeNotSpecified ...
TypeNotSpecified Type = "NotSpecified"
// TypeStatic ...
TypeStatic Type = "Static"
)
func PossibleTypeValues() []Type
PossibleTypeValues returns an array of possible values for the Type const type.