policyassignments

package
v0.20231023.1063038 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2021-06-01/policyassignments Documentation

The policyassignments SDK allows for interaction with the Azure Resource Manager Service resources (API Version 2021-06-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2021-06-01/policyassignments"

Client Initialization

client := policyassignments.NewPolicyAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PolicyAssignmentsClient.Create

ctx := context.TODO()
id := policyassignments.NewScopedPolicyAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "policyAssignmentValue")

payload := policyassignments.PolicyAssignment{
	// ...
}


read, err := client.Create(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PolicyAssignmentsClient.CreateById

ctx := context.TODO()
id := policyassignments.NewPolicyAssignmentIdID("policyAssignmentIdValue")

payload := policyassignments.PolicyAssignment{
	// ...
}


read, err := client.CreateById(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PolicyAssignmentsClient.Delete

ctx := context.TODO()
id := policyassignments.NewScopedPolicyAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "policyAssignmentValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PolicyAssignmentsClient.DeleteById

ctx := context.TODO()
id := policyassignments.NewPolicyAssignmentIdID("policyAssignmentIdValue")

read, err := client.DeleteById(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PolicyAssignmentsClient.Get

ctx := context.TODO()
id := policyassignments.NewScopedPolicyAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "policyAssignmentValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PolicyAssignmentsClient.GetById

ctx := context.TODO()
id := policyassignments.NewPolicyAssignmentIdID("policyAssignmentIdValue")

read, err := client.GetById(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PolicyAssignmentsClient.List

ctx := context.TODO()
id := policyassignments.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.List(ctx, id, policyassignments.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, policyassignments.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: PolicyAssignmentsClient.ListForManagementGroup

ctx := context.TODO()
id := policyassignments.NewManagementGroupID("groupIdValue")

// alternatively `client.ListForManagementGroup(ctx, id, policyassignments.DefaultListForManagementGroupOperationOptions())` can be used to do batched pagination
items, err := client.ListForManagementGroupComplete(ctx, id, policyassignments.DefaultListForManagementGroupOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: PolicyAssignmentsClient.ListForResource

ctx := context.TODO()
id := policyassignments.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

// alternatively `client.ListForResource(ctx, id, policyassignments.DefaultListForResourceOperationOptions())` can be used to do batched pagination
items, err := client.ListForResourceComplete(ctx, id, policyassignments.DefaultListForResourceOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: PolicyAssignmentsClient.ListForResourceGroup

ctx := context.TODO()
id := policyassignments.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ListForResourceGroup(ctx, id, policyassignments.DefaultListForResourceGroupOperationOptions())` can be used to do batched pagination
items, err := client.ListForResourceGroupComplete(ctx, id, policyassignments.DefaultListForResourceGroupOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: PolicyAssignmentsClient.Update

ctx := context.TODO()
id := policyassignments.NewScopedPolicyAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "policyAssignmentValue")

payload := policyassignments.PolicyAssignmentUpdate{
	// ...
}


read, err := client.Update(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PolicyAssignmentsClient.UpdateById

ctx := context.TODO()
id := policyassignments.NewPolicyAssignmentIdID("policyAssignmentIdValue")

payload := policyassignments.PolicyAssignmentUpdate{
	// ...
}


read, err := client.UpdateById(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEnforcementMode 

func PossibleValuesForEnforcementMode() []string

func ValidatePolicyAssignmentIdID 

func ValidatePolicyAssignmentIdID(input interface{}, key string) (warnings []string, errors []error)

ValidatePolicyAssignmentIdID checks that 'input' can be parsed as a Policy Assignment Id ID

func ValidateScopedPolicyAssignmentID 

func ValidateScopedPolicyAssignmentID(input interface{}, key string) (warnings []string, errors []error)

ValidateScopedPolicyAssignmentID checks that 'input' can be parsed as a Scoped Policy Assignment ID

Types

type CreateByIdOperationResponse 

type CreateByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

type DeleteByIdOperationResponse 

type DeleteByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

type EnforcementMode 

type EnforcementMode string
const (
	EnforcementModeDefault      EnforcementMode = "Default"
	EnforcementModeDoNotEnforce EnforcementMode = "DoNotEnforce"
)

func (*EnforcementMode) UnmarshalJSON added in v0.20230509.1154719 

func (s *EnforcementMode) UnmarshalJSON(bytes []byte) error

type GetByIdOperationResponse 

type GetByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []PolicyAssignment
}

type ListForManagementGroupCompleteResult 

type ListForManagementGroupCompleteResult struct {
	Items []PolicyAssignment
}

type ListForManagementGroupOperationOptions 

type ListForManagementGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListForManagementGroupOperationOptions 

func DefaultListForManagementGroupOperationOptions() ListForManagementGroupOperationOptions

func (ListForManagementGroupOperationOptions) ToHeaders added in v0.20230509.1154719 

func (o ListForManagementGroupOperationOptions) ToHeaders() *client.Headers

func (ListForManagementGroupOperationOptions) ToOData added in v0.20230509.1154719 

func (o ListForManagementGroupOperationOptions) ToOData() *odata.Query

func (ListForManagementGroupOperationOptions) ToQuery added in v0.20230509.1154719 

func (o ListForManagementGroupOperationOptions) ToQuery() *client.QueryParams

type ListForManagementGroupOperationResponse 

type ListForManagementGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PolicyAssignment
}

type ListForResourceCompleteResult 

type ListForResourceCompleteResult struct {
	Items []PolicyAssignment
}

type ListForResourceGroupCompleteResult 

type ListForResourceGroupCompleteResult struct {
	Items []PolicyAssignment
}

type ListForResourceGroupOperationOptions 

type ListForResourceGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListForResourceGroupOperationOptions 

func DefaultListForResourceGroupOperationOptions() ListForResourceGroupOperationOptions

func (ListForResourceGroupOperationOptions) ToHeaders added in v0.20230509.1154719 

func (o ListForResourceGroupOperationOptions) ToHeaders() *client.Headers

func (ListForResourceGroupOperationOptions) ToOData added in v0.20230509.1154719 

func (o ListForResourceGroupOperationOptions) ToOData() *odata.Query

func (ListForResourceGroupOperationOptions) ToQuery added in v0.20230509.1154719 

func (o ListForResourceGroupOperationOptions) ToQuery() *client.QueryParams

type ListForResourceGroupOperationResponse 

type ListForResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PolicyAssignment
}

type ListForResourceOperationOptions 

type ListForResourceOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListForResourceOperationOptions 

func DefaultListForResourceOperationOptions() ListForResourceOperationOptions

func (ListForResourceOperationOptions) ToHeaders added in v0.20230509.1154719 

func (o ListForResourceOperationOptions) ToHeaders() *client.Headers

func (ListForResourceOperationOptions) ToOData added in v0.20230509.1154719 

func (o ListForResourceOperationOptions) ToOData() *odata.Query

func (ListForResourceOperationOptions) ToQuery added in v0.20230509.1154719 

func (o ListForResourceOperationOptions) ToQuery() *client.QueryParams

type ListForResourceOperationResponse 

type ListForResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PolicyAssignment
}

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230509.1154719 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230509.1154719 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230509.1154719 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PolicyAssignment
}

type NonComplianceMessage 

type NonComplianceMessage struct {
	Message                     string  `json:"message"`
	PolicyDefinitionReferenceId *string `json:"policyDefinitionReferenceId,omitempty"`
}

type ParameterValuesValue 

type ParameterValuesValue struct {
	Value *interface{} `json:"value,omitempty"`
}

type PolicyAssignment 

type PolicyAssignment struct {
	Id         *string                           `json:"id,omitempty"`
	Identity   *identity.SystemOrUserAssignedMap `json:"identity,omitempty"`
	Location   *string                           `json:"location,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *PolicyAssignmentProperties       `json:"properties,omitempty"`
	SystemData *systemdata.SystemData            `json:"systemData,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type PolicyAssignmentIdId 

type PolicyAssignmentIdId struct {
	PolicyAssignmentId string
}

PolicyAssignmentIdId is a struct representing the Resource ID for a Policy Assignment Id

func NewPolicyAssignmentIdID 

func NewPolicyAssignmentIdID(policyAssignmentId string) PolicyAssignmentIdId

NewPolicyAssignmentIdID returns a new PolicyAssignmentIdId struct

func ParsePolicyAssignmentIdID 

func ParsePolicyAssignmentIdID(input string) (*PolicyAssignmentIdId, error)

ParsePolicyAssignmentIdID parses 'input' into a PolicyAssignmentIdId

func ParsePolicyAssignmentIdIDInsensitively 

func ParsePolicyAssignmentIdIDInsensitively(input string) (*PolicyAssignmentIdId, error)

ParsePolicyAssignmentIdIDInsensitively parses 'input' case-insensitively into a PolicyAssignmentIdId note: this method should only be used for API response data and not user input

func (PolicyAssignmentIdId) ID 

func (id PolicyAssignmentIdId) ID() string

ID returns the formatted Policy Assignment Id ID

func (PolicyAssignmentIdId) Segments 

func (id PolicyAssignmentIdId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Policy Assignment Id ID

func (PolicyAssignmentIdId) String 

func (id PolicyAssignmentIdId) String() string

String returns a human-readable description of this Policy Assignment Id ID

type PolicyAssignmentOperationPredicate 

type PolicyAssignmentOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (PolicyAssignmentOperationPredicate) Matches 

func (p PolicyAssignmentOperationPredicate) Matches(input PolicyAssignment) bool

type PolicyAssignmentProperties 

type PolicyAssignmentProperties struct {
	Description           *string                          `json:"description,omitempty"`
	DisplayName           *string                          `json:"displayName,omitempty"`
	EnforcementMode       *EnforcementMode                 `json:"enforcementMode,omitempty"`
	Metadata              *interface{}                     `json:"metadata,omitempty"`
	NonComplianceMessages *[]NonComplianceMessage          `json:"nonComplianceMessages,omitempty"`
	NotScopes             *[]string                        `json:"notScopes,omitempty"`
	Parameters            *map[string]ParameterValuesValue `json:"parameters,omitempty"`
	PolicyDefinitionId    *string                          `json:"policyDefinitionId,omitempty"`
	Scope                 *string                          `json:"scope,omitempty"`
}

type PolicyAssignmentUpdate 

type PolicyAssignmentUpdate struct {
	Identity *identity.SystemOrUserAssignedMap `json:"identity,omitempty"`
	Location *string                           `json:"location,omitempty"`
}

type PolicyAssignmentsClient 

type PolicyAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewPolicyAssignmentsClientWithBaseURI 

func NewPolicyAssignmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyAssignmentsClient, error)

func (PolicyAssignmentsClient) Create 

func (c PolicyAssignmentsClient) Create(ctx context.Context, id ScopedPolicyAssignmentId, input PolicyAssignment) (result CreateOperationResponse, err error)

Create ...

func (PolicyAssignmentsClient) CreateById 

func (c PolicyAssignmentsClient) CreateById(ctx context.Context, id PolicyAssignmentIdId, input PolicyAssignment) (result CreateByIdOperationResponse, err error)

CreateById ...

func (PolicyAssignmentsClient) Delete 

func (c PolicyAssignmentsClient) Delete(ctx context.Context, id ScopedPolicyAssignmentId) (result DeleteOperationResponse, err error)

Delete ...

func (PolicyAssignmentsClient) DeleteById 

func (c PolicyAssignmentsClient) DeleteById(ctx context.Context, id PolicyAssignmentIdId) (result DeleteByIdOperationResponse, err error)

DeleteById ...

func (PolicyAssignmentsClient) Get 

func (c PolicyAssignmentsClient) Get(ctx context.Context, id ScopedPolicyAssignmentId) (result GetOperationResponse, err error)

Get ...

func (PolicyAssignmentsClient) GetById 

func (c PolicyAssignmentsClient) GetById(ctx context.Context, id PolicyAssignmentIdId) (result GetByIdOperationResponse, err error)

GetById ...

func (PolicyAssignmentsClient) List 

func (c PolicyAssignmentsClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (PolicyAssignmentsClient) ListComplete 

func (c PolicyAssignmentsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PolicyAssignmentsClient) ListCompleteMatchingPredicate 

func (c PolicyAssignmentsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate PolicyAssignmentOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PolicyAssignmentsClient) ListForManagementGroup 

func (c PolicyAssignmentsClient) ListForManagementGroup(ctx context.Context, id commonids.ManagementGroupId, options ListForManagementGroupOperationOptions) (result ListForManagementGroupOperationResponse, err error)

ListForManagementGroup ...

func (PolicyAssignmentsClient) ListForManagementGroupComplete 

func (c PolicyAssignmentsClient) ListForManagementGroupComplete(ctx context.Context, id commonids.ManagementGroupId, options ListForManagementGroupOperationOptions) (ListForManagementGroupCompleteResult, error)

ListForManagementGroupComplete retrieves all the results into a single object

func (PolicyAssignmentsClient) ListForManagementGroupCompleteMatchingPredicate 

func (c PolicyAssignmentsClient) ListForManagementGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ManagementGroupId, options ListForManagementGroupOperationOptions, predicate PolicyAssignmentOperationPredicate) (result ListForManagementGroupCompleteResult, err error)

ListForManagementGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PolicyAssignmentsClient) ListForResource 

func (c PolicyAssignmentsClient) ListForResource(ctx context.Context, id commonids.ScopeId, options ListForResourceOperationOptions) (result ListForResourceOperationResponse, err error)

ListForResource ...

func (PolicyAssignmentsClient) ListForResourceComplete 

func (c PolicyAssignmentsClient) ListForResourceComplete(ctx context.Context, id commonids.ScopeId, options ListForResourceOperationOptions) (ListForResourceCompleteResult, error)

ListForResourceComplete retrieves all the results into a single object

func (PolicyAssignmentsClient) ListForResourceCompleteMatchingPredicate 

func (c PolicyAssignmentsClient) ListForResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListForResourceOperationOptions, predicate PolicyAssignmentOperationPredicate) (result ListForResourceCompleteResult, err error)

ListForResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PolicyAssignmentsClient) ListForResourceGroup 

func (c PolicyAssignmentsClient) ListForResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListForResourceGroupOperationOptions) (result ListForResourceGroupOperationResponse, err error)

ListForResourceGroup ...

func (PolicyAssignmentsClient) ListForResourceGroupComplete 

func (c PolicyAssignmentsClient) ListForResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListForResourceGroupOperationOptions) (ListForResourceGroupCompleteResult, error)

ListForResourceGroupComplete retrieves all the results into a single object

func (PolicyAssignmentsClient) ListForResourceGroupCompleteMatchingPredicate 

func (c PolicyAssignmentsClient) ListForResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListForResourceGroupOperationOptions, predicate PolicyAssignmentOperationPredicate) (result ListForResourceGroupCompleteResult, err error)

ListForResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PolicyAssignmentsClient) Update 

func (c PolicyAssignmentsClient) Update(ctx context.Context, id ScopedPolicyAssignmentId, input PolicyAssignmentUpdate) (result UpdateOperationResponse, err error)

Update ...

func (PolicyAssignmentsClient) UpdateById 

func (c PolicyAssignmentsClient) UpdateById(ctx context.Context, id PolicyAssignmentIdId, input PolicyAssignmentUpdate) (result UpdateByIdOperationResponse, err error)

UpdateById ...

type ScopedPolicyAssignmentId 

type ScopedPolicyAssignmentId struct {
	Scope                string
	PolicyAssignmentName string
}

ScopedPolicyAssignmentId is a struct representing the Resource ID for a Scoped Policy Assignment

func NewScopedPolicyAssignmentID 

func NewScopedPolicyAssignmentID(scope string, policyAssignmentName string) ScopedPolicyAssignmentId

NewScopedPolicyAssignmentID returns a new ScopedPolicyAssignmentId struct

func ParseScopedPolicyAssignmentID 

func ParseScopedPolicyAssignmentID(input string) (*ScopedPolicyAssignmentId, error)

ParseScopedPolicyAssignmentID parses 'input' into a ScopedPolicyAssignmentId

func ParseScopedPolicyAssignmentIDInsensitively 

func ParseScopedPolicyAssignmentIDInsensitively(input string) (*ScopedPolicyAssignmentId, error)

ParseScopedPolicyAssignmentIDInsensitively parses 'input' case-insensitively into a ScopedPolicyAssignmentId note: this method should only be used for API response data and not user input

func (ScopedPolicyAssignmentId) ID 

func (id ScopedPolicyAssignmentId) ID() string

ID returns the formatted Scoped Policy Assignment ID

func (ScopedPolicyAssignmentId) Segments 

func (id ScopedPolicyAssignmentId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Scoped Policy Assignment ID

func (ScopedPolicyAssignmentId) String 

func (id ScopedPolicyAssignmentId) String() string

String returns a human-readable description of this Scoped Policy Assignment ID

type UpdateByIdOperationResponse 

type UpdateByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyAssignment
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.