policyrestrictions

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/policyrestrictions Documentation

The policyrestrictions SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-05-01-preview).

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/2023-05-01-preview/policyrestrictions"

Client Initialization

client := policyrestrictions.NewPolicyRestrictionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PolicyRestrictionsClient.PolicyRestrictionListByService

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

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

Documentation

Index

• func PossibleValuesForPolicyRestrictionRequireBase() []string
• func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
• type PolicyRestrictionContract
• type PolicyRestrictionContractOperationPredicate
  • func (p PolicyRestrictionContractOperationPredicate) Matches(input PolicyRestrictionContract) bool
• type PolicyRestrictionContractProperties
• type PolicyRestrictionListByServiceCompleteResult
• type PolicyRestrictionListByServiceOperationResponse
• type PolicyRestrictionRequireBase
  • func (s *PolicyRestrictionRequireBase) UnmarshalJSON(bytes []byte) error
• type PolicyRestrictionsClient
  • func NewPolicyRestrictionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyRestrictionsClient, error)
  • func (c PolicyRestrictionsClient) PolicyRestrictionListByService(ctx context.Context, id ServiceId) (result PolicyRestrictionListByServiceOperationResponse, err error)
  • func (c PolicyRestrictionsClient) PolicyRestrictionListByServiceComplete(ctx context.Context, id ServiceId) (PolicyRestrictionListByServiceCompleteResult, error)
  • func (c PolicyRestrictionsClient) PolicyRestrictionListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, ...) (result PolicyRestrictionListByServiceCompleteResult, err 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 PossibleValuesForPolicyRestrictionRequireBase

func PossibleValuesForPolicyRestrictionRequireBase() []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 PolicyRestrictionContract

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

type PolicyRestrictionContractOperationPredicate

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

func (PolicyRestrictionContractOperationPredicate) Matches

func (p PolicyRestrictionContractOperationPredicate) Matches(input PolicyRestrictionContract) bool

type PolicyRestrictionContractProperties

type PolicyRestrictionContractProperties struct {
	RequireBase *PolicyRestrictionRequireBase `json:"requireBase,omitempty"`
	Scope       *string                       `json:"scope,omitempty"`
}

type PolicyRestrictionListByServiceCompleteResult

type PolicyRestrictionListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PolicyRestrictionContract
}

type PolicyRestrictionListByServiceOperationResponse

type PolicyRestrictionListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PolicyRestrictionContract
}

type PolicyRestrictionRequireBase

type PolicyRestrictionRequireBase string

const (
	PolicyRestrictionRequireBaseFalse PolicyRestrictionRequireBase = "false"
	PolicyRestrictionRequireBaseTrue  PolicyRestrictionRequireBase = "true"
)

func (*PolicyRestrictionRequireBase) UnmarshalJSON

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

type PolicyRestrictionsClient

type PolicyRestrictionsClient struct {
	Client *resourcemanager.Client
}

func NewPolicyRestrictionsClientWithBaseURI

func NewPolicyRestrictionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyRestrictionsClient, error)

func (PolicyRestrictionsClient) PolicyRestrictionListByService

func (c PolicyRestrictionsClient) PolicyRestrictionListByService(ctx context.Context, id ServiceId) (result PolicyRestrictionListByServiceOperationResponse, err error)

PolicyRestrictionListByService ...

func (PolicyRestrictionsClient) PolicyRestrictionListByServiceComplete

func (c PolicyRestrictionsClient) PolicyRestrictionListByServiceComplete(ctx context.Context, id ServiceId) (PolicyRestrictionListByServiceCompleteResult, error)

PolicyRestrictionListByServiceComplete retrieves all the results into a single object

func (PolicyRestrictionsClient) PolicyRestrictionListByServiceCompleteMatchingPredicate

func (c PolicyRestrictionsClient) PolicyRestrictionListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate PolicyRestrictionContractOperationPredicate) (result PolicyRestrictionListByServiceCompleteResult, err error)

PolicyRestrictionListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

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