policyrestrictionsvalidations

README

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

The policyrestrictionsvalidations 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/policyrestrictionsvalidations"

Client Initialization

client := policyrestrictionsvalidations.NewPolicyRestrictionsValidationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PolicyRestrictionsValidationsClient.PolicyRestrictionValidationsByService

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

if err := client.PolicyRestrictionValidationsByServiceThenPoll(ctx, id); err != nil {
	// handle the error
}

Documentation

Index

• func PossibleValuesForAsyncOperationStatus() []string
• func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
• type AsyncOperationStatus
  • func (s *AsyncOperationStatus) UnmarshalJSON(bytes []byte) error
• type ErrorFieldContract
• type ErrorResponseBody
• type OperationResultContract
• type OperationResultContractProperties
  • func (o *OperationResultContractProperties) GetStartedAsTime() (*time.Time, error)
  • func (o *OperationResultContractProperties) GetUpdatedAsTime() (*time.Time, error)
  • func (o *OperationResultContractProperties) SetStartedAsTime(input time.Time)
  • func (o *OperationResultContractProperties) SetUpdatedAsTime(input time.Time)
• type OperationResultLogItemContract
• type PolicyRestrictionValidationsByServiceOperationResponse
• type PolicyRestrictionsValidationsClient
  • func NewPolicyRestrictionsValidationsClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyRestrictionsValidationsClient, error)
  • func (c PolicyRestrictionsValidationsClient) PolicyRestrictionValidationsByService(ctx context.Context, id ServiceId) (result PolicyRestrictionValidationsByServiceOperationResponse, err error)
  • func (c PolicyRestrictionsValidationsClient) PolicyRestrictionValidationsByServiceThenPoll(ctx context.Context, id ServiceId) 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 PossibleValuesForAsyncOperationStatus

func PossibleValuesForAsyncOperationStatus() []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 AsyncOperationStatus

type AsyncOperationStatus string

const (
	AsyncOperationStatusFailed     AsyncOperationStatus = "Failed"
	AsyncOperationStatusInProgress AsyncOperationStatus = "InProgress"
	AsyncOperationStatusStarted    AsyncOperationStatus = "Started"
	AsyncOperationStatusSucceeded  AsyncOperationStatus = "Succeeded"
)

func (*AsyncOperationStatus) UnmarshalJSON

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

type ErrorFieldContract

type ErrorFieldContract struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

type ErrorResponseBody

type ErrorResponseBody struct {
	Code    *string               `json:"code,omitempty"`
	Details *[]ErrorFieldContract `json:"details,omitempty"`
	Message *string               `json:"message,omitempty"`
}

type OperationResultContract

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

type OperationResultContractProperties

type OperationResultContractProperties struct {
	ActionLog  *[]OperationResultLogItemContract `json:"actionLog,omitempty"`
	Error      *ErrorResponseBody                `json:"error,omitempty"`
	Id         *string                           `json:"id,omitempty"`
	ResultInfo *string                           `json:"resultInfo,omitempty"`
	Started    *string                           `json:"started,omitempty"`
	Status     *AsyncOperationStatus             `json:"status,omitempty"`
	Updated    *string                           `json:"updated,omitempty"`
}

func (*OperationResultContractProperties) GetStartedAsTime

func (o *OperationResultContractProperties) GetStartedAsTime() (*time.Time, error)

func (*OperationResultContractProperties) GetUpdatedAsTime

func (o *OperationResultContractProperties) GetUpdatedAsTime() (*time.Time, error)

func (*OperationResultContractProperties) SetStartedAsTime

func (o *OperationResultContractProperties) SetStartedAsTime(input time.Time)

func (*OperationResultContractProperties) SetUpdatedAsTime

func (o *OperationResultContractProperties) SetUpdatedAsTime(input time.Time)

type OperationResultLogItemContract

type OperationResultLogItemContract struct {
	Action     *string `json:"action,omitempty"`
	ObjectKey  *string `json:"objectKey,omitempty"`
	ObjectType *string `json:"objectType,omitempty"`
}

type PolicyRestrictionValidationsByServiceOperationResponse

type PolicyRestrictionValidationsByServiceOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationResultContract
}

type PolicyRestrictionsValidationsClient

type PolicyRestrictionsValidationsClient struct {
	Client *resourcemanager.Client
}

func NewPolicyRestrictionsValidationsClientWithBaseURI

func NewPolicyRestrictionsValidationsClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyRestrictionsValidationsClient, error)

func (PolicyRestrictionsValidationsClient) PolicyRestrictionValidationsByService

func (c PolicyRestrictionsValidationsClient) PolicyRestrictionValidationsByService(ctx context.Context, id ServiceId) (result PolicyRestrictionValidationsByServiceOperationResponse, err error)

PolicyRestrictionValidationsByService ...

func (PolicyRestrictionsValidationsClient) PolicyRestrictionValidationsByServiceThenPoll

func (c PolicyRestrictionsValidationsClient) PolicyRestrictionValidationsByServiceThenPoll(ctx context.Context, id ServiceId) error

PolicyRestrictionValidationsByServiceThenPoll performs PolicyRestrictionValidationsByService then polls until it's completed

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