policyapi

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armpolicy(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armpolicy). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Index

• type AssignmentsClientAPI
• type DataPolicyManifestsClientAPI
• type DefinitionsClientAPI
• type ExemptionsClientAPI
• type SetDefinitionsClientAPI
• type VariableValuesClientAPI
• type VariablesClientAPI

Types

type AssignmentsClientAPI

type AssignmentsClientAPI interface {
	Create(ctx context.Context, scope string, policyAssignmentName string, parameters policy.Assignment) (result policy.Assignment, err error)
	CreateByID(ctx context.Context, policyAssignmentID string, parameters policy.Assignment) (result policy.Assignment, err error)
	Delete(ctx context.Context, scope string, policyAssignmentName string) (result policy.Assignment, err error)
	DeleteByID(ctx context.Context, policyAssignmentID string) (result policy.Assignment, err error)
	Get(ctx context.Context, scope string, policyAssignmentName string) (result policy.Assignment, err error)
	GetByID(ctx context.Context, policyAssignmentID string) (result policy.Assignment, err error)
	List(ctx context.Context, filter string, top *int32) (result policy.AssignmentListResultPage, err error)
	ListComplete(ctx context.Context, filter string, top *int32) (result policy.AssignmentListResultIterator, err error)
	ListForManagementGroup(ctx context.Context, managementGroupID string, filter string, top *int32) (result policy.AssignmentListResultPage, err error)
	ListForManagementGroupComplete(ctx context.Context, managementGroupID string, filter string, top *int32) (result policy.AssignmentListResultIterator, err error)
	ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string, top *int32) (result policy.AssignmentListResultPage, err error)
	ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string, top *int32) (result policy.AssignmentListResultIterator, err error)
	ListForResourceGroup(ctx context.Context, resourceGroupName string, filter string, top *int32) (result policy.AssignmentListResultPage, err error)
	ListForResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string, top *int32) (result policy.AssignmentListResultIterator, err error)
	Update(ctx context.Context, scope string, policyAssignmentName string, parameters policy.AssignmentUpdate) (result policy.Assignment, err error)
	UpdateByID(ctx context.Context, policyAssignmentID string, parameters policy.AssignmentUpdate) (result policy.Assignment, err error)
}

AssignmentsClientAPI contains the set of methods on the AssignmentsClient type.

type DataPolicyManifestsClientAPI

type DataPolicyManifestsClientAPI interface {
	GetByPolicyMode(ctx context.Context, policyMode string) (result policy.DataPolicyManifest, err error)
	List(ctx context.Context, filter string) (result policy.DataPolicyManifestListResultPage, err error)
	ListComplete(ctx context.Context, filter string) (result policy.DataPolicyManifestListResultIterator, err error)
}

DataPolicyManifestsClientAPI contains the set of methods on the DataPolicyManifestsClient type.

type DefinitionsClientAPI

type DefinitionsClientAPI interface {
	CreateOrUpdate(ctx context.Context, policyDefinitionName string, parameters policy.Definition) (result policy.Definition, err error)
	CreateOrUpdateAtManagementGroup(ctx context.Context, policyDefinitionName string, parameters policy.Definition, managementGroupID string) (result policy.Definition, err error)
	Delete(ctx context.Context, policyDefinitionName string) (result autorest.Response, err error)
	DeleteAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string) (result autorest.Response, err error)
	Get(ctx context.Context, policyDefinitionName string) (result policy.Definition, err error)
	GetAtManagementGroup(ctx context.Context, policyDefinitionName string, managementGroupID string) (result policy.Definition, err error)
	GetBuiltIn(ctx context.Context, policyDefinitionName string) (result policy.Definition, err error)
	List(ctx context.Context, filter string, top *int32) (result policy.DefinitionListResultPage, err error)
	ListComplete(ctx context.Context, filter string, top *int32) (result policy.DefinitionListResultIterator, err error)
	ListBuiltIn(ctx context.Context, filter string, top *int32) (result policy.DefinitionListResultPage, err error)
	ListBuiltInComplete(ctx context.Context, filter string, top *int32) (result policy.DefinitionListResultIterator, err error)
	ListByManagementGroup(ctx context.Context, managementGroupID string, filter string, top *int32) (result policy.DefinitionListResultPage, err error)
	ListByManagementGroupComplete(ctx context.Context, managementGroupID string, filter string, top *int32) (result policy.DefinitionListResultIterator, err error)
}

DefinitionsClientAPI contains the set of methods on the DefinitionsClient type.

type ExemptionsClientAPI

type ExemptionsClientAPI interface {
	CreateOrUpdate(ctx context.Context, scope string, policyExemptionName string, parameters policy.Exemption) (result policy.Exemption, err error)
	Delete(ctx context.Context, scope string, policyExemptionName string) (result autorest.Response, err error)
	Get(ctx context.Context, scope string, policyExemptionName string) (result policy.Exemption, err error)
	List(ctx context.Context, filter string) (result policy.ExemptionListResultPage, err error)
	ListComplete(ctx context.Context, filter string) (result policy.ExemptionListResultIterator, err error)
	ListForManagementGroup(ctx context.Context, managementGroupID string, filter string) (result policy.ExemptionListResultPage, err error)
	ListForManagementGroupComplete(ctx context.Context, managementGroupID string, filter string) (result policy.ExemptionListResultIterator, err error)
	ListForResource(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result policy.ExemptionListResultPage, err error)
	ListForResourceComplete(ctx context.Context, resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, filter string) (result policy.ExemptionListResultIterator, err error)
	ListForResourceGroup(ctx context.Context, resourceGroupName string, filter string) (result policy.ExemptionListResultPage, err error)
	ListForResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string) (result policy.ExemptionListResultIterator, err error)
}

ExemptionsClientAPI contains the set of methods on the ExemptionsClient type.

type SetDefinitionsClientAPI

type SetDefinitionsClientAPI interface {
	CreateOrUpdate(ctx context.Context, policySetDefinitionName string, parameters policy.SetDefinition) (result policy.SetDefinition, err error)
	CreateOrUpdateAtManagementGroup(ctx context.Context, policySetDefinitionName string, parameters policy.SetDefinition, managementGroupID string) (result policy.SetDefinition, err error)
	Delete(ctx context.Context, policySetDefinitionName string) (result autorest.Response, err error)
	DeleteAtManagementGroup(ctx context.Context, policySetDefinitionName string, managementGroupID string) (result autorest.Response, err error)
	Get(ctx context.Context, policySetDefinitionName string) (result policy.SetDefinition, err error)
	GetAtManagementGroup(ctx context.Context, policySetDefinitionName string, managementGroupID string) (result policy.SetDefinition, err error)
	GetBuiltIn(ctx context.Context, policySetDefinitionName string) (result policy.SetDefinition, err error)
	List(ctx context.Context, filter string, top *int32) (result policy.SetDefinitionListResultPage, err error)
	ListComplete(ctx context.Context, filter string, top *int32) (result policy.SetDefinitionListResultIterator, err error)
	ListBuiltIn(ctx context.Context, filter string, top *int32) (result policy.SetDefinitionListResultPage, err error)
	ListBuiltInComplete(ctx context.Context, filter string, top *int32) (result policy.SetDefinitionListResultIterator, err error)
	ListByManagementGroup(ctx context.Context, managementGroupID string, filter string, top *int32) (result policy.SetDefinitionListResultPage, err error)
	ListByManagementGroupComplete(ctx context.Context, managementGroupID string, filter string, top *int32) (result policy.SetDefinitionListResultIterator, err error)
}

SetDefinitionsClientAPI contains the set of methods on the SetDefinitionsClient type.

type VariableValuesClientAPI

type VariableValuesClientAPI interface {
	CreateOrUpdate(ctx context.Context, variableName string, variableValueName string, parameters policy.VariableValue) (result policy.VariableValue, err error)
	CreateOrUpdateAtManagementGroup(ctx context.Context, managementGroupID string, variableName string, variableValueName string, parameters policy.VariableValue) (result policy.VariableValue, err error)
	Delete(ctx context.Context, variableName string, variableValueName string) (result autorest.Response, err error)
	DeleteAtManagementGroup(ctx context.Context, managementGroupID string, variableName string, variableValueName string) (result autorest.Response, err error)
	Get(ctx context.Context, variableName string, variableValueName string) (result policy.VariableValue, err error)
	GetAtManagementGroup(ctx context.Context, managementGroupID string, variableName string, variableValueName string) (result policy.VariableValue, err error)
	List(ctx context.Context, variableName string) (result policy.VariableValueListResultPage, err error)
	ListComplete(ctx context.Context, variableName string) (result policy.VariableValueListResultIterator, err error)
	ListForManagementGroup(ctx context.Context, managementGroupID string, variableName string) (result policy.VariableValueListResultPage, err error)
	ListForManagementGroupComplete(ctx context.Context, managementGroupID string, variableName string) (result policy.VariableValueListResultIterator, err error)
}

VariableValuesClientAPI contains the set of methods on the VariableValuesClient type.

type VariablesClientAPI

type VariablesClientAPI interface {
	CreateOrUpdate(ctx context.Context, variableName string, parameters policy.Variable) (result policy.Variable, err error)
	CreateOrUpdateAtManagementGroup(ctx context.Context, managementGroupID string, variableName string, parameters policy.Variable) (result policy.Variable, err error)
	Delete(ctx context.Context, variableName string) (result autorest.Response, err error)
	DeleteAtManagementGroup(ctx context.Context, managementGroupID string, variableName string) (result autorest.Response, err error)
	Get(ctx context.Context, variableName string) (result policy.Variable, err error)
	GetAtManagementGroup(ctx context.Context, managementGroupID string, variableName string) (result policy.Variable, err error)
	List(ctx context.Context) (result policy.VariableListResultPage, err error)
	ListComplete(ctx context.Context) (result policy.VariableListResultIterator, err error)
	ListForManagementGroup(ctx context.Context, managementGroupID string) (result policy.VariableListResultPage, err error)
	ListForManagementGroupComplete(ctx context.Context, managementGroupID string) (result policy.VariableListResultIterator, err error)
}

VariablesClientAPI contains the set of methods on the VariablesClient type.