Documentation ¶
Index ¶
- type Assignment
- type AssignmentListResult
- type AssignmentProperties
- type AssignmentsClient
- func (client *AssignmentsClient) Create(ctx context.Context, scope string, policyAssignmentName string, ...) (AssignmentsClientCreateResponse, error)
- func (client *AssignmentsClient) CreateByID(ctx context.Context, policyAssignmentID string, parameters Assignment, ...) (AssignmentsClientCreateByIDResponse, error)
- func (client *AssignmentsClient) Delete(ctx context.Context, scope string, policyAssignmentName string, ...) (AssignmentsClientDeleteResponse, error)
- func (client *AssignmentsClient) DeleteByID(ctx context.Context, policyAssignmentID string, ...) (AssignmentsClientDeleteByIDResponse, error)
- func (client *AssignmentsClient) Get(ctx context.Context, scope string, policyAssignmentName string, ...) (AssignmentsClientGetResponse, error)
- func (client *AssignmentsClient) GetByID(ctx context.Context, policyAssignmentID string, ...) (AssignmentsClientGetByIDResponse, error)
- func (client *AssignmentsClient) NewListForResourceGroupPager(resourceGroupName string, ...) *runtime.Pager[AssignmentsClientListForResourceGroupResponse]
- func (client *AssignmentsClient) NewListForResourcePager(resourceGroupName string, resourceProviderNamespace string, ...) *runtime.Pager[AssignmentsClientListForResourceResponse]
- func (client *AssignmentsClient) NewListPager(options *AssignmentsClientListOptions) *runtime.Pager[AssignmentsClientListResponse]
- type AssignmentsClientCreateByIDOptions
- type AssignmentsClientCreateByIDResponse
- type AssignmentsClientCreateOptions
- type AssignmentsClientCreateResponse
- type AssignmentsClientDeleteByIDOptions
- type AssignmentsClientDeleteByIDResponse
- type AssignmentsClientDeleteOptions
- type AssignmentsClientDeleteResponse
- type AssignmentsClientGetByIDOptions
- type AssignmentsClientGetByIDResponse
- type AssignmentsClientGetOptions
- type AssignmentsClientGetResponse
- type AssignmentsClientListForResourceGroupOptions
- type AssignmentsClientListForResourceGroupResponse
- type AssignmentsClientListForResourceOptions
- type AssignmentsClientListForResourceResponse
- type AssignmentsClientListOptions
- type AssignmentsClientListResponse
- type ClientFactory
- type Definition
- type DefinitionListResult
- type DefinitionProperties
- type DefinitionsClient
- func (client *DefinitionsClient) CreateOrUpdate(ctx context.Context, policyDefinitionName string, parameters Definition, ...) (DefinitionsClientCreateOrUpdateResponse, error)
- func (client *DefinitionsClient) CreateOrUpdateAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, ...) (DefinitionsClientCreateOrUpdateAtManagementGroupResponse, error)
- func (client *DefinitionsClient) Delete(ctx context.Context, policyDefinitionName string, ...) (DefinitionsClientDeleteResponse, error)
- func (client *DefinitionsClient) DeleteAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, ...) (DefinitionsClientDeleteAtManagementGroupResponse, error)
- func (client *DefinitionsClient) Get(ctx context.Context, policyDefinitionName string, ...) (DefinitionsClientGetResponse, error)
- func (client *DefinitionsClient) GetAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, ...) (DefinitionsClientGetAtManagementGroupResponse, error)
- func (client *DefinitionsClient) GetBuiltIn(ctx context.Context, policyDefinitionName string, ...) (DefinitionsClientGetBuiltInResponse, error)
- func (client *DefinitionsClient) NewListBuiltInPager(options *DefinitionsClientListBuiltInOptions) *runtime.Pager[DefinitionsClientListBuiltInResponse]
- func (client *DefinitionsClient) NewListByManagementGroupPager(managementGroupID string, ...) *runtime.Pager[DefinitionsClientListByManagementGroupResponse]
- func (client *DefinitionsClient) NewListPager(options *DefinitionsClientListOptions) *runtime.Pager[DefinitionsClientListResponse]
- type DefinitionsClientCreateOrUpdateAtManagementGroupOptions
- type DefinitionsClientCreateOrUpdateAtManagementGroupResponse
- type DefinitionsClientCreateOrUpdateOptions
- type DefinitionsClientCreateOrUpdateResponse
- type DefinitionsClientDeleteAtManagementGroupOptions
- type DefinitionsClientDeleteAtManagementGroupResponse
- type DefinitionsClientDeleteOptions
- type DefinitionsClientDeleteResponse
- type DefinitionsClientGetAtManagementGroupOptions
- type DefinitionsClientGetAtManagementGroupResponse
- type DefinitionsClientGetBuiltInOptions
- type DefinitionsClientGetBuiltInResponse
- type DefinitionsClientGetOptions
- type DefinitionsClientGetResponse
- type DefinitionsClientListBuiltInOptions
- type DefinitionsClientListBuiltInResponse
- type DefinitionsClientListByManagementGroupOptions
- type DefinitionsClientListByManagementGroupResponse
- type DefinitionsClientListOptions
- type DefinitionsClientListResponse
- type PolicyMode
- type PolicyType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Assignment ¶
type Assignment struct { // The name of the policy assignment. Name *string `json:"name,omitempty"` // Properties for the policy assignment. Properties *AssignmentProperties `json:"properties,omitempty"` // The type of the policy assignment. Type *string `json:"type,omitempty"` // READ-ONLY; The ID of the policy assignment. ID *string `json:"id,omitempty" azure:"ro"` }
Assignment - The policy assignment.
func (Assignment) MarshalJSON ¶
func (a Assignment) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type Assignment.
func (*Assignment) UnmarshalJSON ¶
func (a *Assignment) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type Assignment.
type AssignmentListResult ¶
type AssignmentListResult struct { // The URL to use for getting the next set of results. NextLink *string `json:"nextLink,omitempty"` // An array of policy assignments. Value []*Assignment `json:"value,omitempty"` }
AssignmentListResult - List of policy assignments.
func (AssignmentListResult) MarshalJSON ¶
func (a AssignmentListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AssignmentListResult.
func (*AssignmentListResult) UnmarshalJSON ¶
func (a *AssignmentListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AssignmentListResult.
type AssignmentProperties ¶
type AssignmentProperties struct { // This message will be part of response in case of policy violation. Description *string `json:"description,omitempty"` // The display name of the policy assignment. DisplayName *string `json:"displayName,omitempty"` // Required if a parameter is used in policy rule. Parameters any `json:"parameters,omitempty"` // The ID of the policy definition. PolicyDefinitionID *string `json:"policyDefinitionId,omitempty"` // The scope for the policy assignment. Scope *string `json:"scope,omitempty"` }
AssignmentProperties - The policy assignment properties.
func (AssignmentProperties) MarshalJSON ¶
func (a AssignmentProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AssignmentProperties.
func (*AssignmentProperties) UnmarshalJSON ¶
func (a *AssignmentProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AssignmentProperties.
type AssignmentsClient ¶
type AssignmentsClient struct {
// contains filtered or unexported fields
}
AssignmentsClient contains the methods for the PolicyAssignments group. Don't use this type directly, use NewAssignmentsClient() instead.
func NewAssignmentsClient ¶
func NewAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AssignmentsClient, error)
NewAssignmentsClient creates a new instance of AssignmentsClient with the specified values.
- subscriptionID - The ID of the target subscription.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*AssignmentsClient) Create ¶
func (client *AssignmentsClient) Create(ctx context.Context, scope string, policyAssignmentName string, parameters Assignment, options *AssignmentsClientCreateOptions) (AssignmentsClientCreateResponse, error)
Create - Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- scope - The scope of the policy assignment.
- policyAssignmentName - The name of the policy assignment.
- parameters - Parameters for the policy assignment.
- options - AssignmentsClientCreateOptions contains the optional parameters for the AssignmentsClient.Create method.
func (*AssignmentsClient) CreateByID ¶
func (client *AssignmentsClient) CreateByID(ctx context.Context, policyAssignmentID string, parameters Assignment, options *AssignmentsClientCreateByIDOptions) (AssignmentsClientCreateByIDResponse, error)
CreateByID - Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyAssignmentID - The ID of the policy assignment to create. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'.
- parameters - Parameters for policy assignment.
- options - AssignmentsClientCreateByIDOptions contains the optional parameters for the AssignmentsClient.CreateByID method.
func (*AssignmentsClient) Delete ¶
func (client *AssignmentsClient) Delete(ctx context.Context, scope string, policyAssignmentName string, options *AssignmentsClientDeleteOptions) (AssignmentsClientDeleteResponse, error)
Delete - Deletes a policy assignment. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- scope - The scope of the policy assignment.
- policyAssignmentName - The name of the policy assignment to delete.
- options - AssignmentsClientDeleteOptions contains the optional parameters for the AssignmentsClient.Delete method.
func (*AssignmentsClient) DeleteByID ¶
func (client *AssignmentsClient) DeleteByID(ctx context.Context, policyAssignmentID string, options *AssignmentsClientDeleteByIDOptions) (AssignmentsClientDeleteByIDResponse, error)
DeleteByID - When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyAssignmentID - The ID of the policy assignment to delete. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'.
- options - AssignmentsClientDeleteByIDOptions contains the optional parameters for the AssignmentsClient.DeleteByID method.
func (*AssignmentsClient) Get ¶
func (client *AssignmentsClient) Get(ctx context.Context, scope string, policyAssignmentName string, options *AssignmentsClientGetOptions) (AssignmentsClientGetResponse, error)
Get - Gets a policy assignment. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- scope - The scope of the policy assignment.
- policyAssignmentName - The name of the policy assignment to get.
- options - AssignmentsClientGetOptions contains the optional parameters for the AssignmentsClient.Get method.
func (*AssignmentsClient) GetByID ¶
func (client *AssignmentsClient) GetByID(ctx context.Context, policyAssignmentID string, options *AssignmentsClientGetByIDOptions) (AssignmentsClientGetByIDResponse, error)
GetByID - When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyAssignmentID - The ID of the policy assignment to get. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'.
- options - AssignmentsClientGetByIDOptions contains the optional parameters for the AssignmentsClient.GetByID method.
func (*AssignmentsClient) NewListForResourceGroupPager ¶
func (client *AssignmentsClient) NewListForResourceGroupPager(resourceGroupName string, options *AssignmentsClientListForResourceGroupOptions) *runtime.Pager[AssignmentsClientListForResourceGroupResponse]
NewListForResourceGroupPager - Gets policy assignments for the resource group.
Generated from API version 2016-12-01
- resourceGroupName - The name of the resource group that contains policy assignments.
- options - AssignmentsClientListForResourceGroupOptions contains the optional parameters for the AssignmentsClient.NewListForResourceGroupPager method.
func (*AssignmentsClient) NewListForResourcePager ¶
func (client *AssignmentsClient) NewListForResourcePager(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, options *AssignmentsClientListForResourceOptions) *runtime.Pager[AssignmentsClientListForResourceResponse]
NewListForResourcePager - Gets policy assignments for a resource.
Generated from API version 2016-12-01
- resourceGroupName - The name of the resource group containing the resource. The name is case insensitive.
- resourceProviderNamespace - The namespace of the resource provider.
- parentResourcePath - The parent resource path.
- resourceType - The resource type.
- resourceName - The name of the resource with policy assignments.
- options - AssignmentsClientListForResourceOptions contains the optional parameters for the AssignmentsClient.NewListForResourcePager method.
func (*AssignmentsClient) NewListPager ¶
func (client *AssignmentsClient) NewListPager(options *AssignmentsClientListOptions) *runtime.Pager[AssignmentsClientListResponse]
NewListPager - Gets all the policy assignments for a subscription.
Generated from API version 2016-12-01
- options - AssignmentsClientListOptions contains the optional parameters for the AssignmentsClient.NewListPager method.
type AssignmentsClientCreateByIDOptions ¶
type AssignmentsClientCreateByIDOptions struct { }
AssignmentsClientCreateByIDOptions contains the optional parameters for the AssignmentsClient.CreateByID method.
type AssignmentsClientCreateByIDResponse ¶
type AssignmentsClientCreateByIDResponse struct {
Assignment
}
AssignmentsClientCreateByIDResponse contains the response from method AssignmentsClient.CreateByID.
type AssignmentsClientCreateOptions ¶
type AssignmentsClientCreateOptions struct { }
AssignmentsClientCreateOptions contains the optional parameters for the AssignmentsClient.Create method.
type AssignmentsClientCreateResponse ¶
type AssignmentsClientCreateResponse struct {
Assignment
}
AssignmentsClientCreateResponse contains the response from method AssignmentsClient.Create.
type AssignmentsClientDeleteByIDOptions ¶
type AssignmentsClientDeleteByIDOptions struct { }
AssignmentsClientDeleteByIDOptions contains the optional parameters for the AssignmentsClient.DeleteByID method.
type AssignmentsClientDeleteByIDResponse ¶
type AssignmentsClientDeleteByIDResponse struct {
Assignment
}
AssignmentsClientDeleteByIDResponse contains the response from method AssignmentsClient.DeleteByID.
type AssignmentsClientDeleteOptions ¶
type AssignmentsClientDeleteOptions struct { }
AssignmentsClientDeleteOptions contains the optional parameters for the AssignmentsClient.Delete method.
type AssignmentsClientDeleteResponse ¶
type AssignmentsClientDeleteResponse struct {
Assignment
}
AssignmentsClientDeleteResponse contains the response from method AssignmentsClient.Delete.
type AssignmentsClientGetByIDOptions ¶
type AssignmentsClientGetByIDOptions struct { }
AssignmentsClientGetByIDOptions contains the optional parameters for the AssignmentsClient.GetByID method.
type AssignmentsClientGetByIDResponse ¶
type AssignmentsClientGetByIDResponse struct {
Assignment
}
AssignmentsClientGetByIDResponse contains the response from method AssignmentsClient.GetByID.
type AssignmentsClientGetOptions ¶
type AssignmentsClientGetOptions struct { }
AssignmentsClientGetOptions contains the optional parameters for the AssignmentsClient.Get method.
type AssignmentsClientGetResponse ¶
type AssignmentsClientGetResponse struct {
Assignment
}
AssignmentsClientGetResponse contains the response from method AssignmentsClient.Get.
type AssignmentsClientListForResourceGroupOptions ¶
type AssignmentsClientListForResourceGroupOptions struct { // The filter to apply on the operation. Filter *string }
AssignmentsClientListForResourceGroupOptions contains the optional parameters for the AssignmentsClient.NewListForResourceGroupPager method.
type AssignmentsClientListForResourceGroupResponse ¶
type AssignmentsClientListForResourceGroupResponse struct {
AssignmentListResult
}
AssignmentsClientListForResourceGroupResponse contains the response from method AssignmentsClient.NewListForResourceGroupPager.
type AssignmentsClientListForResourceOptions ¶
type AssignmentsClientListForResourceOptions struct { // The filter to apply on the operation. Filter *string }
AssignmentsClientListForResourceOptions contains the optional parameters for the AssignmentsClient.NewListForResourcePager method.
type AssignmentsClientListForResourceResponse ¶
type AssignmentsClientListForResourceResponse struct {
AssignmentListResult
}
AssignmentsClientListForResourceResponse contains the response from method AssignmentsClient.NewListForResourcePager.
type AssignmentsClientListOptions ¶
type AssignmentsClientListOptions struct { // The filter to apply on the operation. Filter *string }
AssignmentsClientListOptions contains the optional parameters for the AssignmentsClient.NewListPager method.
type AssignmentsClientListResponse ¶
type AssignmentsClientListResponse struct {
AssignmentListResult
}
AssignmentsClientListResponse contains the response from method AssignmentsClient.NewListPager.
type ClientFactory ¶
type ClientFactory struct {
// contains filtered or unexported fields
}
ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.
func NewClientFactory ¶
func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)
NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.
- subscriptionID - The ID of the target subscription.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*ClientFactory) NewAssignmentsClient ¶
func (c *ClientFactory) NewAssignmentsClient() *AssignmentsClient
func (*ClientFactory) NewDefinitionsClient ¶
func (c *ClientFactory) NewDefinitionsClient() *DefinitionsClient
type Definition ¶
type Definition struct { // The policy definition properties. Properties *DefinitionProperties `json:"properties,omitempty"` // READ-ONLY; The ID of the policy definition. ID *string `json:"id,omitempty" azure:"ro"` // READ-ONLY; The name of the policy definition. Name *string `json:"name,omitempty" azure:"ro"` }
Definition - The policy definition.
func (Definition) MarshalJSON ¶
func (d Definition) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type Definition.
func (*Definition) UnmarshalJSON ¶
func (d *Definition) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type Definition.
type DefinitionListResult ¶
type DefinitionListResult struct { // The URL to use for getting the next set of results. NextLink *string `json:"nextLink,omitempty"` // An array of policy definitions. Value []*Definition `json:"value,omitempty"` }
DefinitionListResult - List of policy definitions.
func (DefinitionListResult) MarshalJSON ¶
func (d DefinitionListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DefinitionListResult.
func (*DefinitionListResult) UnmarshalJSON ¶
func (d *DefinitionListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DefinitionListResult.
type DefinitionProperties ¶
type DefinitionProperties struct { // The policy definition description. Description *string `json:"description,omitempty"` // The display name of the policy definition. DisplayName *string `json:"displayName,omitempty"` // The policy definition metadata. Metadata any `json:"metadata,omitempty"` // The policy definition mode. Possible values are NotSpecified, Indexed, and All. Mode *PolicyMode `json:"mode,omitempty"` // Required if a parameter is used in policy rule. Parameters any `json:"parameters,omitempty"` // The policy rule. PolicyRule any `json:"policyRule,omitempty"` // The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. PolicyType *PolicyType `json:"policyType,omitempty"` }
DefinitionProperties - The policy definition properties.
func (DefinitionProperties) MarshalJSON ¶
func (d DefinitionProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DefinitionProperties.
func (*DefinitionProperties) UnmarshalJSON ¶
func (d *DefinitionProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DefinitionProperties.
type DefinitionsClient ¶
type DefinitionsClient struct {
// contains filtered or unexported fields
}
DefinitionsClient contains the methods for the PolicyDefinitions group. Don't use this type directly, use NewDefinitionsClient() instead.
func NewDefinitionsClient ¶
func NewDefinitionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DefinitionsClient, error)
NewDefinitionsClient creates a new instance of DefinitionsClient with the specified values.
- subscriptionID - The ID of the target subscription.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*DefinitionsClient) CreateOrUpdate ¶
func (client *DefinitionsClient) CreateOrUpdate(ctx context.Context, policyDefinitionName string, parameters Definition, options *DefinitionsClientCreateOrUpdateOptions) (DefinitionsClientCreateOrUpdateResponse, error)
CreateOrUpdate - Creates or updates a policy definition. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyDefinitionName - The name of the policy definition to create.
- parameters - The policy definition properties.
- options - DefinitionsClientCreateOrUpdateOptions contains the optional parameters for the DefinitionsClient.CreateOrUpdate method.
func (*DefinitionsClient) CreateOrUpdateAtManagementGroup ¶
func (client *DefinitionsClient) CreateOrUpdateAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, parameters Definition, options *DefinitionsClientCreateOrUpdateAtManagementGroupOptions) (DefinitionsClientCreateOrUpdateAtManagementGroupResponse, error)
CreateOrUpdateAtManagementGroup - Creates or updates a policy definition at management group level. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyDefinitionName - The name of the policy definition to create.
- managementGroupID - The ID of the management group.
- parameters - The policy definition properties.
- options - DefinitionsClientCreateOrUpdateAtManagementGroupOptions contains the optional parameters for the DefinitionsClient.CreateOrUpdateAtManagementGroup method.
func (*DefinitionsClient) Delete ¶
func (client *DefinitionsClient) Delete(ctx context.Context, policyDefinitionName string, options *DefinitionsClientDeleteOptions) (DefinitionsClientDeleteResponse, error)
Delete - Deletes a policy definition. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyDefinitionName - The name of the policy definition to delete.
- options - DefinitionsClientDeleteOptions contains the optional parameters for the DefinitionsClient.Delete method.
func (*DefinitionsClient) DeleteAtManagementGroup ¶
func (client *DefinitionsClient) DeleteAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, options *DefinitionsClientDeleteAtManagementGroupOptions) (DefinitionsClientDeleteAtManagementGroupResponse, error)
DeleteAtManagementGroup - Deletes a policy definition at management group level. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyDefinitionName - The name of the policy definition to delete.
- managementGroupID - The ID of the management group.
- options - DefinitionsClientDeleteAtManagementGroupOptions contains the optional parameters for the DefinitionsClient.DeleteAtManagementGroup method.
func (*DefinitionsClient) Get ¶
func (client *DefinitionsClient) Get(ctx context.Context, policyDefinitionName string, options *DefinitionsClientGetOptions) (DefinitionsClientGetResponse, error)
Get - Gets the policy definition. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyDefinitionName - The name of the policy definition to get.
- options - DefinitionsClientGetOptions contains the optional parameters for the DefinitionsClient.Get method.
func (*DefinitionsClient) GetAtManagementGroup ¶
func (client *DefinitionsClient) GetAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string, options *DefinitionsClientGetAtManagementGroupOptions) (DefinitionsClientGetAtManagementGroupResponse, error)
GetAtManagementGroup - Gets the policy definition at management group level. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyDefinitionName - The name of the policy definition to get.
- managementGroupID - The ID of the management group.
- options - DefinitionsClientGetAtManagementGroupOptions contains the optional parameters for the DefinitionsClient.GetAtManagementGroup method.
func (*DefinitionsClient) GetBuiltIn ¶
func (client *DefinitionsClient) GetBuiltIn(ctx context.Context, policyDefinitionName string, options *DefinitionsClientGetBuiltInOptions) (DefinitionsClientGetBuiltInResponse, error)
GetBuiltIn - Gets the built in policy definition. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2016-12-01
- policyDefinitionName - The name of the built in policy definition to get.
- options - DefinitionsClientGetBuiltInOptions contains the optional parameters for the DefinitionsClient.GetBuiltIn method.
func (*DefinitionsClient) NewListBuiltInPager ¶
func (client *DefinitionsClient) NewListBuiltInPager(options *DefinitionsClientListBuiltInOptions) *runtime.Pager[DefinitionsClientListBuiltInResponse]
NewListBuiltInPager - Gets all the built in policy definitions.
Generated from API version 2016-12-01
- options - DefinitionsClientListBuiltInOptions contains the optional parameters for the DefinitionsClient.NewListBuiltInPager method.
func (*DefinitionsClient) NewListByManagementGroupPager ¶
func (client *DefinitionsClient) NewListByManagementGroupPager(managementGroupID string, options *DefinitionsClientListByManagementGroupOptions) *runtime.Pager[DefinitionsClientListByManagementGroupResponse]
NewListByManagementGroupPager - Gets all the policy definitions for a subscription at management group level.
Generated from API version 2016-12-01
- managementGroupID - The ID of the management group.
- options - DefinitionsClientListByManagementGroupOptions contains the optional parameters for the DefinitionsClient.NewListByManagementGroupPager method.
func (*DefinitionsClient) NewListPager ¶
func (client *DefinitionsClient) NewListPager(options *DefinitionsClientListOptions) *runtime.Pager[DefinitionsClientListResponse]
NewListPager - Gets all the policy definitions for a subscription.
Generated from API version 2016-12-01
- options - DefinitionsClientListOptions contains the optional parameters for the DefinitionsClient.NewListPager method.
type DefinitionsClientCreateOrUpdateAtManagementGroupOptions ¶
type DefinitionsClientCreateOrUpdateAtManagementGroupOptions struct { }
DefinitionsClientCreateOrUpdateAtManagementGroupOptions contains the optional parameters for the DefinitionsClient.CreateOrUpdateAtManagementGroup method.
type DefinitionsClientCreateOrUpdateAtManagementGroupResponse ¶
type DefinitionsClientCreateOrUpdateAtManagementGroupResponse struct {
Definition
}
DefinitionsClientCreateOrUpdateAtManagementGroupResponse contains the response from method DefinitionsClient.CreateOrUpdateAtManagementGroup.
type DefinitionsClientCreateOrUpdateOptions ¶
type DefinitionsClientCreateOrUpdateOptions struct { }
DefinitionsClientCreateOrUpdateOptions contains the optional parameters for the DefinitionsClient.CreateOrUpdate method.
type DefinitionsClientCreateOrUpdateResponse ¶
type DefinitionsClientCreateOrUpdateResponse struct {
Definition
}
DefinitionsClientCreateOrUpdateResponse contains the response from method DefinitionsClient.CreateOrUpdate.
type DefinitionsClientDeleteAtManagementGroupOptions ¶
type DefinitionsClientDeleteAtManagementGroupOptions struct { }
DefinitionsClientDeleteAtManagementGroupOptions contains the optional parameters for the DefinitionsClient.DeleteAtManagementGroup method.
type DefinitionsClientDeleteAtManagementGroupResponse ¶
type DefinitionsClientDeleteAtManagementGroupResponse struct { }
DefinitionsClientDeleteAtManagementGroupResponse contains the response from method DefinitionsClient.DeleteAtManagementGroup.
type DefinitionsClientDeleteOptions ¶
type DefinitionsClientDeleteOptions struct { }
DefinitionsClientDeleteOptions contains the optional parameters for the DefinitionsClient.Delete method.
type DefinitionsClientDeleteResponse ¶
type DefinitionsClientDeleteResponse struct { }
DefinitionsClientDeleteResponse contains the response from method DefinitionsClient.Delete.
type DefinitionsClientGetAtManagementGroupOptions ¶
type DefinitionsClientGetAtManagementGroupOptions struct { }
DefinitionsClientGetAtManagementGroupOptions contains the optional parameters for the DefinitionsClient.GetAtManagementGroup method.
type DefinitionsClientGetAtManagementGroupResponse ¶
type DefinitionsClientGetAtManagementGroupResponse struct {
Definition
}
DefinitionsClientGetAtManagementGroupResponse contains the response from method DefinitionsClient.GetAtManagementGroup.
type DefinitionsClientGetBuiltInOptions ¶
type DefinitionsClientGetBuiltInOptions struct { }
DefinitionsClientGetBuiltInOptions contains the optional parameters for the DefinitionsClient.GetBuiltIn method.
type DefinitionsClientGetBuiltInResponse ¶
type DefinitionsClientGetBuiltInResponse struct {
Definition
}
DefinitionsClientGetBuiltInResponse contains the response from method DefinitionsClient.GetBuiltIn.
type DefinitionsClientGetOptions ¶
type DefinitionsClientGetOptions struct { }
DefinitionsClientGetOptions contains the optional parameters for the DefinitionsClient.Get method.
type DefinitionsClientGetResponse ¶
type DefinitionsClientGetResponse struct {
Definition
}
DefinitionsClientGetResponse contains the response from method DefinitionsClient.Get.
type DefinitionsClientListBuiltInOptions ¶
type DefinitionsClientListBuiltInOptions struct { }
DefinitionsClientListBuiltInOptions contains the optional parameters for the DefinitionsClient.NewListBuiltInPager method.
type DefinitionsClientListBuiltInResponse ¶
type DefinitionsClientListBuiltInResponse struct {
DefinitionListResult
}
DefinitionsClientListBuiltInResponse contains the response from method DefinitionsClient.NewListBuiltInPager.
type DefinitionsClientListByManagementGroupOptions ¶
type DefinitionsClientListByManagementGroupOptions struct { }
DefinitionsClientListByManagementGroupOptions contains the optional parameters for the DefinitionsClient.NewListByManagementGroupPager method.
type DefinitionsClientListByManagementGroupResponse ¶
type DefinitionsClientListByManagementGroupResponse struct {
DefinitionListResult
}
DefinitionsClientListByManagementGroupResponse contains the response from method DefinitionsClient.NewListByManagementGroupPager.
type DefinitionsClientListOptions ¶
type DefinitionsClientListOptions struct { }
DefinitionsClientListOptions contains the optional parameters for the DefinitionsClient.NewListPager method.
type DefinitionsClientListResponse ¶
type DefinitionsClientListResponse struct {
DefinitionListResult
}
DefinitionsClientListResponse contains the response from method DefinitionsClient.NewListPager.
type PolicyMode ¶
type PolicyMode string
PolicyMode - The policy definition mode. Possible values are NotSpecified, Indexed, and All.
const ( PolicyModeAll PolicyMode = "All" PolicyModeIndexed PolicyMode = "Indexed" PolicyModeNotSpecified PolicyMode = "NotSpecified" )
func PossiblePolicyModeValues ¶
func PossiblePolicyModeValues() []PolicyMode
PossiblePolicyModeValues returns the possible values for the PolicyMode const type.
type PolicyType ¶
type PolicyType string
PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom.
const ( PolicyTypeBuiltIn PolicyType = "BuiltIn" PolicyTypeCustom PolicyType = "Custom" PolicyTypeNotSpecified PolicyType = "NotSpecified" )
func PossiblePolicyTypeValues ¶
func PossiblePolicyTypeValues() []PolicyType
PossiblePolicyTypeValues returns the possible values for the PolicyType const type.