allpolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/allpolicies Documentation

The allpolicies SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2024-05-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/apimanagement/2024-05-01/allpolicies"

Client Initialization

client := allpolicies.NewAllPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AllPoliciesClient.ListByService

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

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

Documentation

Index

• func PossibleValuesForPolicyComplianceState() []string
• func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
• type AllPoliciesClient
  • func NewAllPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*AllPoliciesClient, error)
  • func (c AllPoliciesClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)
  • func (c AllPoliciesClient) ListByServiceComplete(ctx context.Context, id ServiceId) (ListByServiceCompleteResult, error)
  • func (c AllPoliciesClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, ...) (result ListByServiceCompleteResult, err error)
• type AllPoliciesContract
• type AllPoliciesContractOperationPredicate
  • func (p AllPoliciesContractOperationPredicate) Matches(input AllPoliciesContract) bool
• type AllPoliciesContractProperties
• type ListByServiceCompleteResult
• type ListByServiceCustomPager
  • func (p *ListByServiceCustomPager) NextPageLink() *odata.Link
• type ListByServiceOperationResponse
• type PolicyComplianceState
  • func (s *PolicyComplianceState) UnmarshalJSON(bytes []byte) error
• type ServiceId
  • func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId
  • func ParseServiceID(input string) (*ServiceId, error)
  • func ParseServiceIDInsensitively(input string) (*ServiceId, error)
  • func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id ServiceId) ID() string
  • func (id ServiceId) Segments() []resourceids.Segment
  • func (id ServiceId) String() string

Functions

func PossibleValuesForPolicyComplianceState

func PossibleValuesForPolicyComplianceState() []string

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type AllPoliciesClient

type AllPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewAllPoliciesClientWithBaseURI

func NewAllPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*AllPoliciesClient, error)

func (AllPoliciesClient) ListByService

func (c AllPoliciesClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)

ListByService ...

func (AllPoliciesClient) ListByServiceComplete

func (c AllPoliciesClient) ListByServiceComplete(ctx context.Context, id ServiceId) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (AllPoliciesClient) ListByServiceCompleteMatchingPredicate

func (c AllPoliciesClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate AllPoliciesContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type AllPoliciesContract

type AllPoliciesContract struct {
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *AllPoliciesContractProperties `json:"properties,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type AllPoliciesContractOperationPredicate

type AllPoliciesContractOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (AllPoliciesContractOperationPredicate) Matches

func (p AllPoliciesContractOperationPredicate) Matches(input AllPoliciesContract) bool

type AllPoliciesContractProperties

type AllPoliciesContractProperties struct {
	ComplianceState   *PolicyComplianceState `json:"complianceState,omitempty"`
	ReferencePolicyId *string                `json:"referencePolicyId,omitempty"`
}

type ListByServiceCompleteResult

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AllPoliciesContract
}

type ListByServiceCustomPager

type ListByServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByServiceCustomPager) NextPageLink

func (p *ListByServiceCustomPager) NextPageLink() *odata.Link

type ListByServiceOperationResponse

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AllPoliciesContract
}

type PolicyComplianceState

type PolicyComplianceState string

const (
	PolicyComplianceStateCompliant    PolicyComplianceState = "Compliant"
	PolicyComplianceStateNonCompliant PolicyComplianceState = "NonCompliant"
	PolicyComplianceStatePending      PolicyComplianceState = "Pending"
)

func (*PolicyComplianceState) UnmarshalJSON

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

type ServiceId

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult

func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Service ID

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID